{"items":[{"type":"link","fsPath":"docs/index.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Home","link":"/docs","routeSlug":"/docs"},{"type":"group","fsPath":"docs/tutorials/welcome.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Welcome to Rebilly","link":"/docs/tutorials/welcome","routeSlug":"/docs/tutorials/welcome","items":[{"type":"group","fsPath":"docs/tutorials/payment-processing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment processing","link":"/docs/tutorials/payment-processing","routeSlug":"/docs/tutorials/payment-processing","items":[{"type":"link","fsPath":"docs/tutorials/payment-management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment management","link":"/docs/tutorials/payment-management","routeSlug":"/docs/tutorials/payment-management"}]},{"type":"group","fsPath":"docs/tutorials/billing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Billing","link":"/docs/tutorials/billing","routeSlug":"/docs/tutorials/billing","items":[{"type":"link","fsPath":"docs/tutorials/billing-management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Billing management","link":"/docs/tutorials/billing-management","routeSlug":"/docs/tutorials/billing-management"}]},{"type":"link","fsPath":"docs/tutorials/customer-management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customer management","link":"/docs/tutorials/customer-management","routeSlug":"/docs/tutorials/customer-management"},{"type":"link","fsPath":"docs/tutorials/user-management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"User management","link":"/docs/tutorials/user-management","routeSlug":"/docs/tutorials/user-management"},{"type":"group","fsPath":"docs/tutorials/automations.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automations","link":"/docs/tutorials/automations","routeSlug":"/docs/tutorials/automations","items":[{"type":"link","fsPath":"docs/tutorials/risk-management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Risk management","link":"/docs/tutorials/risk-management","routeSlug":"/docs/tutorials/risk-management"}]},{"type":"link","fsPath":"docs/tutorials/environments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Environments","link":"/docs/tutorials/environments","routeSlug":"/docs/tutorials/environments"},{"type":"link","fsPath":"docs/tutorials/tax-management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tax management","link":"/docs/tutorials/tax-management","routeSlug":"/docs/tutorials/tax-management"},{"type":"link","fsPath":"docs/tutorials/kpis-and-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KPIs and reports","link":"/docs/tutorials/kpis-and-reports","routeSlug":"/docs/tutorials/kpis-and-reports"},{"type":"link","fsPath":"docs/tutorials/kyc-and-aml.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC and AML","link":"/docs/tutorials/kyc-and-aml","routeSlug":"/docs/tutorials/kyc-and-aml"}],"menuStyle":"drilldown"},{"type":"group","fsPath":"docs/tutorials/tutorials.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"User interface guides","link":"/docs/tutorials/tutorials","routeSlug":"/docs/tutorials/tutorials","items":[{"type":"separator","label":"Get started"},{"type":"link","fsPath":"docs/tutorials/basic-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Basic integration","link":"/docs/tutorials/basic-integration","routeSlug":"/docs/tutorials/basic-integration"},{"type":"link","fsPath":"docs/tutorials/search.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Search in Rebilly","link":"/docs/tutorials/search","routeSlug":"/docs/tutorials/search"},{"type":"separator","label":"Usage guides"},{"type":"group","fsPath":"docs/kpis/kpis.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KPIs","link":"/docs/kpis/kpis","routeSlug":"/docs/kpis/kpis","items":[{"type":"link","fsPath":"docs/kpis/payments-kpis.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payments KPIs","link":"/docs/kpis/payments-kpis","routeSlug":"/docs/kpis/payments-kpis"},{"type":"link","fsPath":"docs/kpis/billing-kpis.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Billing KPIs","link":"/docs/kpis/billing-kpis","routeSlug":"/docs/kpis/billing-kpis"},{"type":"link","fsPath":"docs/kpis/kyc-kpis.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC KPIs","link":"/docs/kpis/kyc-kpis","routeSlug":"/docs/kpis/kyc-kpis"},{"type":"link","fsPath":"docs/kpis/kpi-segments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KPI segments","link":"/docs/kpis/kpi-segments","routeSlug":"/docs/kpis/kpi-segments"}],"icon":"/assets/kpis.659685c536f9bed95ce4f23ad9c67883ce4dfa348730d99aa6d24bf4e779f2f3.824f2bd4.svg"},{"type":"group","fsPath":"docs/data-tables/data-tables.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Data tables","link":"/docs/data-tables/data-tables","routeSlug":"/docs/data-tables/data-tables","items":[{"type":"group","fsPath":"docs/data-tables/manage-customers.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customers","link":"/docs/data-tables/manage-customers","routeSlug":"/docs/data-tables/manage-customers","items":[{"type":"link","fsPath":"docs/data-tables/manage-customer-information.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage customer information","link":"/docs/data-tables/manage-customer-information","routeSlug":"/docs/data-tables/manage-customer-information"},{"type":"link","fsPath":"docs/data-tables/manage-customer-payments-and-billing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage customer payments and billing","link":"/docs/data-tables/manage-customer-payments-and-billing","routeSlug":"/docs/data-tables/manage-customer-payments-and-billing"},{"type":"group","fsPath":"docs/data-tables/manage-customer-compliance.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage customer compliance","link":"/docs/data-tables/manage-customer-compliance","routeSlug":"/docs/data-tables/manage-customer-compliance"}]},{"type":"group","fsPath":"docs/data-tables/payments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payments","link":"/docs/data-tables/payments","routeSlug":"/docs/data-tables/payments","items":[{"type":"link","fsPath":"docs/data-tables/manage-payments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage payments","link":"/docs/data-tables/manage-payments","routeSlug":"/docs/data-tables/manage-payments"},{"type":"link","fsPath":"docs/data-tables/manage-payout-requests.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage payout requests","link":"/docs/data-tables/manage-payout-requests","routeSlug":"/docs/data-tables/manage-payout-requests"},{"type":"link","fsPath":"docs/data-tables/manage-deposit-requests.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage deposit requests","link":"/docs/data-tables/manage-deposit-requests","routeSlug":"/docs/data-tables/manage-deposit-requests"}]},{"type":"group","fsPath":"docs/data-tables/manage-billing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Billing","link":"/docs/data-tables/manage-billing","routeSlug":"/docs/data-tables/manage-billing","items":[{"type":"link","fsPath":"docs/data-tables/manage-autopay.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage autopay","link":"/docs/data-tables/manage-autopay","routeSlug":"/docs/data-tables/manage-autopay"},{"type":"link","fsPath":"docs/data-tables/manage-credit-memos.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage credit memos","link":"/docs/data-tables/manage-credit-memos","routeSlug":"/docs/data-tables/manage-credit-memos"},{"type":"link","fsPath":"docs/data-tables/manage-delinquency-periods.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage delinquency periods","link":"/docs/data-tables/manage-delinquency-periods","routeSlug":"/docs/data-tables/manage-delinquency-periods"},{"type":"link","fsPath":"docs/data-tables/manage-invoices.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage invoices","link":"/docs/data-tables/manage-invoices","routeSlug":"/docs/data-tables/manage-invoices"},{"type":"link","fsPath":"docs/data-tables/manage-quotes.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage quotes","link":"/docs/data-tables/manage-quotes","routeSlug":"/docs/data-tables/manage-quotes"},{"type":"link","fsPath":"docs/data-tables/manage-subscriptions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage orders","link":"/docs/data-tables/manage-subscriptions","routeSlug":"/docs/data-tables/manage-subscriptions"}]},{"type":"link","fsPath":"docs/data-tables/manage-logs.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Logs","link":"/docs/data-tables/manage-logs","routeSlug":"/docs/data-tables/manage-logs"},{"type":"link","fsPath":"docs/data-tables/manage-kyc.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC","link":"/docs/data-tables/manage-kyc","routeSlug":"/docs/data-tables/manage-kyc"},{"type":"link","fsPath":"docs/data-tables/manage-aml.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"AML","link":"/docs/data-tables/manage-aml","routeSlug":"/docs/data-tables/manage-aml"},{"type":"link","fsPath":"docs/data-tables/customize-tables.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customize tables","link":"/docs/data-tables/customize-tables","routeSlug":"/docs/data-tables/customize-tables"},{"type":"link","fsPath":"docs/data-tables/set-relative-time-filters.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set relative time filters","link":"/docs/data-tables/set-relative-time-filters","routeSlug":"/docs/data-tables/set-relative-time-filters"}],"icon":"/assets/data-tables.21346ef6b84ccf69b458e992e25e8b33d6d47cee1c2d4ccb603c39a69bf70020.824f2bd4.svg"},{"type":"group","fsPath":"docs/automations/automation.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automations","link":"/docs/automations/automation","routeSlug":"/docs/automations/automation","items":[{"type":"group","fsPath":"docs/automations/rules-engine.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Rules engine","link":"/docs/automations/rules-engine","routeSlug":"/docs/automations/rules-engine","items":[{"type":"link","fsPath":"docs/automations/action-types.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Actions","link":"/docs/automations/action-types","routeSlug":"/docs/automations/action-types"},{"type":"link","fsPath":"docs/automations/event-types.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Events","link":"/docs/automations/event-types","routeSlug":"/docs/automations/event-types"},{"type":"link","fsPath":"docs/automations/rules-and-binds.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Rules and binds","link":"/docs/automations/rules-and-binds","routeSlug":"/docs/automations/rules-and-binds"},{"type":"link","fsPath":"docs/automations/create-a-value-list.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Value lists","link":"/docs/automations/create-a-value-list","routeSlug":"/docs/automations/create-a-value-list"},{"type":"link","fsPath":"docs/automations/automation-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automation reports","link":"/docs/automations/automation-reports","routeSlug":"/docs/automations/automation-reports"}]},{"type":"link","fsPath":"docs/automations/payments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payments","link":"/docs/automations/payments","routeSlug":"/docs/automations/payments"},{"type":"group","fsPath":"docs/automations/data-and-alerts.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Data and alerts","link":"/docs/automations/data-and-alerts","routeSlug":"/docs/automations/data-and-alerts","items":[{"type":"group","fsPath":"docs/automations/automated-tagging.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automated tagging","link":"/docs/automations/automated-tagging","routeSlug":"/docs/automations/automated-tagging","items":[{"type":"link","fsPath":"docs/automations/tag-events.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tag events","link":"/docs/automations/tag-events","routeSlug":"/docs/automations/tag-events"}]},{"type":"link","fsPath":"docs/automations/data-exports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Data exports","link":"/docs/automations/data-exports","routeSlug":"/docs/automations/data-exports"},{"type":"group","fsPath":"docs/automations/email-notifications.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Email notifications","link":"/docs/automations/email-notifications","routeSlug":"/docs/automations/email-notifications","items":[{"type":"link","fsPath":"docs/automations/email-notifications-events.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Email notification events","link":"/docs/automations/email-notifications-events","routeSlug":"/docs/automations/email-notifications-events"}]}]},{"type":"group","fsPath":"docs/automations/risk.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Risk","link":"/docs/automations/risk","routeSlug":"/docs/automations/risk","items":[{"type":"link","fsPath":"docs/automations/allowlists.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Allowlists","link":"/docs/automations/allowlists","routeSlug":"/docs/automations/allowlists"},{"type":"link","fsPath":"docs/automations/blocklists.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Blocklists","link":"/docs/automations/blocklists","routeSlug":"/docs/automations/blocklists"},{"type":"link","fsPath":"docs/automations/risk-scoring.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Risk scoring","link":"/docs/automations/risk-scoring","routeSlug":"/docs/automations/risk-scoring"},{"type":"link","fsPath":"docs/automations/disputes-and-fraud.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Disputes and fraud","link":"/docs/automations/disputes-and-fraud","routeSlug":"/docs/automations/disputes-and-fraud"}]},{"type":"group","fsPath":"docs/automations/development.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Development","link":"/docs/automations/development","routeSlug":"/docs/automations/development","items":[{"type":"group","fsPath":"docs/automations/webhooks.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Webhooks","link":"/docs/automations/webhooks","routeSlug":"/docs/automations/webhooks","items":[{"type":"link","fsPath":"docs/automations/webhook-events.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Webhook events","link":"/docs/automations/webhook-events","routeSlug":"/docs/automations/webhook-events"}]}]},{"type":"group","fsPath":"docs/tutorials/common-automations.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Common automations","link":"/docs/tutorials/common-automations","routeSlug":"/docs/tutorials/common-automations","items":[{"type":"link","fsPath":"docs/tutorials/create-a-velocity-limit.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Create a velocity limit","link":"/docs/tutorials/create-a-velocity-limit","routeSlug":"/docs/tutorials/create-a-velocity-limit"},{"type":"link","fsPath":"docs/tutorials/automate-emailing-invoices.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automate invoice emailing","link":"/docs/tutorials/automate-emailing-invoices","routeSlug":"/docs/tutorials/automate-emailing-invoices"},{"type":"link","fsPath":"docs/tutorials/involuntary-churn.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Reduce involuntary churn","link":"/docs/tutorials/involuntary-churn","routeSlug":"/docs/tutorials/involuntary-churn"}]}],"icon":"/assets/automations.167e9b4522e7243e2ee2078206b8e6e6ffd624d791bb006201e5319bb8e8c068.824f2bd4.svg"},{"type":"group","fsPath":"docs/app-store/app-store.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"App store","link":"/docs/app-store/app-store","routeSlug":"/docs/app-store/app-store","items":[{"type":"link","fsPath":"docs/app-store/google-sheets-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Google Sheets integration","link":"/docs/app-store/google-sheets-integration","routeSlug":"/docs/app-store/google-sheets-integration"},{"type":"link","fsPath":"docs/app-store/plaid-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Plaid integration","link":"/docs/app-store/plaid-integration","routeSlug":"/docs/app-store/plaid-integration"},{"type":"link","fsPath":"docs/app-store/experian-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Experian integration","link":"/docs/app-store/experian-integration","routeSlug":"/docs/app-store/experian-integration"},{"type":"link","fsPath":"docs/app-store/tax-jar-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"TaxJar integration","link":"/docs/app-store/tax-jar-integration","routeSlug":"/docs/app-store/tax-jar-integration"},{"type":"link","fsPath":"docs/app-store/avalara-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Avalara integration","link":"/docs/app-store/avalara-integration","routeSlug":"/docs/app-store/avalara-integration"},{"type":"link","fsPath":"docs/app-store/quickbooks-online-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"QuickBooks Online integration","link":"/docs/app-store/quickbooks-online-integration","routeSlug":"/docs/app-store/quickbooks-online-integration"}],"icon":"/assets/app-store.b1502fb04634956ce6299300e678bfdcaf83510d8e4550fce6d72c023b3295f9.824f2bd4.svg"},{"type":"group","fsPath":"docs/reports/reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Reports","link":"/docs/reports/reports","routeSlug":"/docs/reports/reports","items":[{"type":"link","fsPath":"docs/reports/payment-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment reports","link":"/docs/reports/payment-reports","routeSlug":"/docs/reports/payment-reports"},{"type":"link","fsPath":"docs/reports/billing-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Billing reports","link":"/docs/reports/billing-reports","routeSlug":"/docs/reports/billing-reports"},{"type":"link","fsPath":"docs/reports/api-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"API reports","link":"/docs/reports/api-reports","routeSlug":"/docs/reports/api-reports"},{"type":"link","fsPath":"docs/reports/automation-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automation reports","link":"/docs/reports/automation-reports","routeSlug":"/docs/reports/automation-reports"},{"type":"link","fsPath":"docs/reports/kyc-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC reports","link":"/docs/reports/kyc-reports","routeSlug":"/docs/reports/kyc-reports"},{"type":"link","fsPath":"docs/reports/aml-reports.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"AML reports","link":"/docs/reports/aml-reports","routeSlug":"/docs/reports/aml-reports"},{"type":"link","fsPath":"docs/data-tables/revenue-recognition.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Revenue recognition","link":"/docs/data-tables/revenue-recognition","routeSlug":"/docs/data-tables/revenue-recognition"}],"icon":"/assets/reports.d5d807ff714a24ae58d8b8f6d7cfabad7ae742ac2841ffbfa82cf70977cc07bd.824f2bd4.svg"},{"type":"group","fsPath":"docs/settings/settings.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Settings","link":"/docs/settings/settings","routeSlug":"/docs/settings/settings","items":[{"type":"group","fsPath":"docs/settings/configuration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Configuration","link":"/docs/settings/configuration","routeSlug":"/docs/settings/configuration","items":[{"type":"link","fsPath":"docs/settings/billing-portals.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Billing portals","link":"/docs/settings/billing-portals","routeSlug":"/docs/settings/billing-portals"},{"type":"link","fsPath":"docs/settings/email-delivery-settings.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Email delivery settings","link":"/docs/settings/email-delivery-settings","routeSlug":"/docs/settings/email-delivery-settings"},{"type":"link","fsPath":"docs/settings/fees.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Fees","link":"/docs/settings/fees","routeSlug":"/docs/settings/fees"},{"type":"group","fsPath":"docs/settings/payment-gateway.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Gateway accounts","link":"/docs/settings/payment-gateway","routeSlug":"/docs/settings/payment-gateway","items":[{"type":"link","fsPath":"docs/settings/set-up-a-gateway.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set up a payment gateway","link":"/docs/settings/set-up-a-gateway","routeSlug":"/docs/settings/set-up-a-gateway"},{"type":"link","fsPath":"docs/settings/gateway-routing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment gateway routing","link":"/docs/settings/gateway-routing","routeSlug":"/docs/settings/gateway-routing"},{"type":"link","fsPath":"docs/settings/payment-methods.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment and payout methods","link":"/docs/settings/payment-methods","routeSlug":"/docs/settings/payment-methods"},{"type":"link","fsPath":"docs/settings/display-payment-methods-by-location.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Display payment methods by location","link":"/docs/settings/display-payment-methods-by-location","routeSlug":"/docs/settings/display-payment-methods-by-location"},{"type":"group","fsPath":"docs/settings/manage-payment-gateways.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage payment gateways","link":"/docs/settings/manage-payment-gateways","routeSlug":"/docs/settings/manage-payment-gateways","items":[{"type":"link","fsPath":"docs/settings/add-paypal-account.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Add a PayPal account","link":"/docs/settings/add-paypal-account","routeSlug":"/docs/settings/add-paypal-account"},{"type":"link","fsPath":"docs/dev-docs/add-an-intuit-payment-gateway-account.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Add an Intuit account","link":"/docs/dev-docs/add-an-intuit-payment-gateway-account","routeSlug":"/docs/dev-docs/add-an-intuit-payment-gateway-account"}]},{"type":"link","fsPath":"docs/settings/integration-requests.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Gateway integration requests","link":"/docs/settings/integration-requests","routeSlug":"/docs/settings/integration-requests"},{"type":"link","fsPath":"docs/settings/supported-currencies.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Supported currencies","link":"/docs/settings/supported-currencies","routeSlug":"/docs/settings/supported-currencies"},{"type":"link","fsPath":"docs/settings/dynamic-currency-conversion.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Dynamic currency conversion","link":"/docs/settings/dynamic-currency-conversion","routeSlug":"/docs/settings/dynamic-currency-conversion"},{"type":"link","fsPath":"docs/settings/recurring-payments-3rd-party-approval.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Recurring payments & third-party approval","link":"/docs/settings/recurring-payments-3rd-party-approval","routeSlug":"/docs/settings/recurring-payments-3rd-party-approval"},{"type":"link","fsPath":"docs/settings/3ds.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"3D Secure","link":"/docs/settings/3ds","routeSlug":"/docs/settings/3ds"}]},{"type":"link","fsPath":"docs/settings/journal-account.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Journal accounts","link":"/docs/settings/journal-account","routeSlug":"/docs/settings/journal-account"}]},{"type":"group","fsPath":"docs/settings/pricing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Pricing","link":"/docs/settings/pricing","routeSlug":"/docs/settings/pricing","items":[{"type":"link","fsPath":"docs/settings/coupons-and-discounts.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Coupons","link":"/docs/settings/coupons-and-discounts","routeSlug":"/docs/settings/coupons-and-discounts"},{"type":"group","fsPath":"docs/settings/products-and-pricing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Products & pricing","link":"/docs/settings/products-and-pricing","routeSlug":"/docs/settings/products-and-pricing","items":[{"type":"link","fsPath":"docs/settings/pricing-formulas.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Pricing formulas","link":"/docs/settings/pricing-formulas","routeSlug":"/docs/settings/pricing-formulas"}]},{"type":"link","fsPath":"docs/settings/shipping.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Shipping rates","link":"/docs/settings/shipping","routeSlug":"/docs/settings/shipping"}]},{"type":"group","fsPath":"docs/settings/management.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Management","link":"/docs/settings/management","routeSlug":"/docs/settings/management","items":[{"type":"link","fsPath":"docs/settings/custom-fields.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Custom fields","link":"/docs/settings/custom-fields","routeSlug":"/docs/settings/custom-fields"},{"type":"link","fsPath":"docs/settings/organizations-and-websites.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"My organizations & websites","link":"/docs/settings/organizations-and-websites","routeSlug":"/docs/settings/organizations-and-websites"},{"type":"link","fsPath":"docs/settings/segments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Segments","link":"/docs/settings/segments","routeSlug":"/docs/settings/segments"},{"type":"link","fsPath":"docs/settings/tags.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tags","link":"/docs/settings/tags","routeSlug":"/docs/settings/tags"},{"type":"group","fsPath":"docs/settings/users.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Users","link":"/docs/settings/users","routeSlug":"/docs/settings/users","items":[{"type":"link","fsPath":"docs/settings/user-permissions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"User permissions","link":"/docs/settings/user-permissions","routeSlug":"/docs/settings/user-permissions"}]}]},{"type":"group","fsPath":"docs/settings/payment-forms.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment forms","link":"/docs/settings/payment-forms","routeSlug":"/docs/settings/payment-forms","items":[{"type":"link","fsPath":"docs/settings/deposit-strategies.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Deposit amount strategies","link":"/docs/settings/deposit-strategies","routeSlug":"/docs/settings/deposit-strategies"},{"type":"link","fsPath":"docs/settings/hosted-payment-forms.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Hosted payment forms","link":"/docs/settings/hosted-payment-forms","routeSlug":"/docs/settings/hosted-payment-forms"},{"type":"link","fsPath":"docs/settings/payment-method-configuration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment method configuration","link":"/docs/settings/payment-method-configuration","routeSlug":"/docs/settings/payment-method-configuration"},{"type":"link","fsPath":"docs/settings/payout-method-configuration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payout method configuration","link":"/docs/settings/payout-method-configuration","routeSlug":"/docs/settings/payout-method-configuration"}]},{"type":"link","fsPath":"docs/settings/taxes.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Taxes","link":"/docs/settings/taxes","routeSlug":"/docs/settings/taxes"},{"type":"group","fsPath":"docs/settings/kyc-and-aml.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC & AML","link":"/docs/settings/kyc-and-aml","routeSlug":"/docs/settings/kyc-and-aml","items":[{"type":"link","fsPath":"docs/settings/kyc.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC","link":"/docs/settings/kyc","routeSlug":"/docs/settings/kyc"},{"type":"link","fsPath":"docs/settings/aml.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"AML","link":"/docs/settings/aml","routeSlug":"/docs/settings/aml"}]}],"icon":"/assets/settings.09eca49425d16b1bdf78e2146282c20eb861d7bfaad712b915b585386cb62bde.824f2bd4.svg"},{"type":"group","fsPath":"docs/tutorials/product-training/index.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Product training","link":"/docs/tutorials/product-training","routeSlug":"/docs/tutorials/product-training","items":[{"type":"link","fsPath":"docs/tutorials/product-training/set-up-your-training-evironment.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 1: Set up your training environment","link":"/docs/tutorials/product-training/set-up-your-training-evironment","routeSlug":"/docs/tutorials/product-training/set-up-your-training-evironment"},{"type":"link","fsPath":"docs/tutorials/product-training/create-customers.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 2: Create customers","link":"/docs/tutorials/product-training/create-customers","routeSlug":"/docs/tutorials/product-training/create-customers"},{"type":"link","fsPath":"docs/tutorials/product-training/collect-payments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 3: Collect payments","link":"/docs/tutorials/product-training/collect-payments","routeSlug":"/docs/tutorials/product-training/collect-payments"},{"type":"link","fsPath":"docs/tutorials/product-training/create-products-and-pricing-plans.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 4: Products and pricing plans","link":"/docs/tutorials/product-training/create-products-and-pricing-plans","routeSlug":"/docs/tutorials/product-training/create-products-and-pricing-plans"},{"type":"link","fsPath":"docs/tutorials/product-training/create-orders-using-app.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 5: Create orders in Rebilly","link":"/docs/tutorials/product-training/create-orders-using-app","routeSlug":"/docs/tutorials/product-training/create-orders-using-app"},{"type":"link","fsPath":"docs/tutorials/product-training/cancel-orders.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 6: Cancel orders","link":"/docs/tutorials/product-training/cancel-orders","routeSlug":"/docs/tutorials/product-training/cancel-orders"},{"type":"link","fsPath":"docs/tutorials/product-training/pause-orders.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 7: Pause orders","link":"/docs/tutorials/product-training/pause-orders","routeSlug":"/docs/tutorials/product-training/pause-orders"},{"type":"link","fsPath":"docs/tutorials/product-training/reactivate-orders.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 8: Reactivate orders","link":"/docs/tutorials/product-training/reactivate-orders","routeSlug":"/docs/tutorials/product-training/reactivate-orders"},{"type":"link","fsPath":"docs/tutorials/product-training/change-orders.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 9: Change orders","link":"/docs/tutorials/product-training/change-orders","routeSlug":"/docs/tutorials/product-training/change-orders"},{"type":"link","fsPath":"docs/tutorials/product-training/create-and-redeem-coupons.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 10: Create and redeem coupons","link":"/docs/tutorials/product-training/create-and-redeem-coupons","routeSlug":"/docs/tutorials/product-training/create-and-redeem-coupons"},{"type":"link","fsPath":"docs/tutorials/product-training/refund-transactions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 11: Refund transactions","link":"/docs/tutorials/product-training/refund-transactions","routeSlug":"/docs/tutorials/product-training/refund-transactions"},{"type":"link","fsPath":"docs/tutorials/product-training/refund-invoices.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 12: Refund invoices","link":"/docs/tutorials/product-training/refund-invoices","routeSlug":"/docs/tutorials/product-training/refund-invoices"},{"type":"link","fsPath":"docs/tutorials/product-training/timeline-reviews.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 13: Timeline reviews","link":"/docs/tutorials/product-training/timeline-reviews","routeSlug":"/docs/tutorials/product-training/timeline-reviews"},{"type":"link","fsPath":"docs/tutorials/product-training/exporting-data.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 14: Export data","link":"/docs/tutorials/product-training/exporting-data","routeSlug":"/docs/tutorials/product-training/exporting-data"},{"type":"link","fsPath":"docs/tutorials/product-training/log-a-dispute.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 15: Log a dispute","link":"/docs/tutorials/product-training/log-a-dispute","routeSlug":"/docs/tutorials/product-training/log-a-dispute"},{"type":"link","fsPath":"docs/tutorials/product-training/create-credit-memos.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 16: Create credit memos","link":"/docs/tutorials/product-training/create-credit-memos","routeSlug":"/docs/tutorials/product-training/create-credit-memos"},{"type":"link","fsPath":"docs/tutorials/product-training/update-a-customers-billing-address.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 17: Update a customer's billing address","link":"/docs/tutorials/product-training/update-a-customers-billing-address","routeSlug":"/docs/tutorials/product-training/update-a-customers-billing-address"},{"type":"link","fsPath":"docs/tutorials/product-training/update-a-customers-primary-address.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 18: Update a customer's primary address","link":"/docs/tutorials/product-training/update-a-customers-primary-address","routeSlug":"/docs/tutorials/product-training/update-a-customers-primary-address"},{"type":"link","fsPath":"docs/tutorials/product-training/update-an-orders-renewal-date.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Task 19: Update the renewal date of an order","link":"/docs/tutorials/product-training/update-an-orders-renewal-date","routeSlug":"/docs/tutorials/product-training/update-an-orders-renewal-date"}]},{"type":"separator","label":"Test and go live"},{"type":"link","fsPath":"docs/tutorials/go-live.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Go live checklist","link":"/docs/tutorials/go-live","routeSlug":"/docs/tutorials/go-live"},{"type":"separator","label":"Miscellaneous"},{"type":"link","fsPath":"docs/tutorials/migrate-sensitive-payment-data.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Migrate sensitive payment data","link":"/docs/tutorials/migrate-sensitive-payment-data","routeSlug":"/docs/tutorials/migrate-sensitive-payment-data"}],"menuStyle":"drilldown"},{"type":"group","fsPath":"docs/dev-docs/index.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Developer docs","link":"/docs/dev-docs","routeSlug":"/docs/dev-docs","items":[{"type":"separator","label":"Get started"},{"type":"link","fsPath":"docs/dev-docs/get-started-integrate-hosted-payments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate a hosted payment form","link":"/docs/dev-docs/get-started-integrate-hosted-payments","routeSlug":"/docs/dev-docs/get-started-integrate-hosted-payments"},{"type":"group","fsPath":"docs/dev-docs/get-started-integrate-payments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate embedded payment forms","link":"/docs/dev-docs/get-started-integrate-payments","routeSlug":"/docs/dev-docs/get-started-integrate-payments","items":[{"type":"group","fsPath":"docs/dev-docs/get-started-integrate-payment-forms.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment forms","link":"/docs/dev-docs/get-started-integrate-payment-forms","routeSlug":"/docs/dev-docs/get-started-integrate-payment-forms","items":[{"type":"link","fsPath":"docs/dev-docs/integrate-a-payment-form.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate a payment form","link":"/docs/dev-docs/integrate-a-payment-form","routeSlug":"/docs/dev-docs/integrate-a-payment-form"},{"type":"link","fsPath":"docs/dev-docs/process-a-payment-jwt.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment form using a JWT","link":"/docs/dev-docs/process-a-payment-jwt","routeSlug":"/docs/dev-docs/process-a-payment-jwt"},{"type":"group","fsPath":"docs/dev-docs/customize-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customize","link":"/docs/dev-docs/customize-rebilly-instruments","routeSlug":"/docs/dev-docs/customize-rebilly-instruments","items":[{"type":"link","fsPath":"docs/dev-docs/customize-style-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Style","link":"/docs/dev-docs/customize-style-rebilly-instruments","routeSlug":"/docs/dev-docs/customize-style-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/customize-localize-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Localize","link":"/docs/dev-docs/customize-localize-rebilly-instruments","routeSlug":"/docs/dev-docs/customize-localize-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/customize-layout-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Layout","link":"/docs/dev-docs/customize-layout-rebilly-instruments","routeSlug":"/docs/dev-docs/customize-layout-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/css-reference-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"CSS reference","link":"/docs/dev-docs/css-reference-rebilly-instruments","routeSlug":"/docs/dev-docs/css-reference-rebilly-instruments"}]},{"type":"group","fsPath":"docs/dev-docs/examples-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Examples","link":"/docs/dev-docs/examples-rebilly-instruments","routeSlug":"/docs/dev-docs/examples-rebilly-instruments","items":[{"type":"link","fsPath":"docs/dev-docs/setup-rebilly-instruments-package-manager.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Use a package manager","link":"/docs/dev-docs/setup-rebilly-instruments-package-manager","routeSlug":"/docs/dev-docs/setup-rebilly-instruments-package-manager"},{"type":"link","fsPath":"docs/dev-docs/example-rebilly-instruments-purchase-data.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Provide purchase data","link":"/docs/dev-docs/example-rebilly-instruments-purchase-data","routeSlug":"/docs/dev-docs/example-rebilly-instruments-purchase-data"},{"type":"link","fsPath":"docs/dev-docs/setup-rebilly-instruments-managing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage payment instrument options","link":"/docs/dev-docs/setup-rebilly-instruments-managing","routeSlug":"/docs/dev-docs/setup-rebilly-instruments-managing"},{"type":"link","fsPath":"docs/dev-docs/custom-confirm-result-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Custom confirm and results screens","link":"/docs/dev-docs/custom-confirm-result-rebilly-instruments","routeSlug":"/docs/dev-docs/custom-confirm-result-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/update-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Update the configuration","link":"/docs/dev-docs/update-rebilly-instruments","routeSlug":"/docs/dev-docs/update-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/payment-instrument-setup-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Make a payment instrument available for future use","link":"/docs/dev-docs/payment-instrument-setup-rebilly-instruments","routeSlug":"/docs/dev-docs/payment-instrument-setup-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/setup-rebilly-instruments-add-on.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set up an add-on","link":"/docs/dev-docs/setup-rebilly-instruments-add-on","routeSlug":"/docs/dev-docs/setup-rebilly-instruments-add-on"},{"type":"link","fsPath":"docs/dev-docs/setup-rebilly-instruments-bump-offer.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set up a bump offer","link":"/docs/dev-docs/setup-rebilly-instruments-bump-offer","routeSlug":"/docs/dev-docs/setup-rebilly-instruments-bump-offer"},{"type":"link","fsPath":"docs/dev-docs/setup-rebilly-instruments-paypal.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set up PayPal","link":"/docs/dev-docs/setup-rebilly-instruments-paypal","routeSlug":"/docs/dev-docs/setup-rebilly-instruments-paypal"},{"type":"link","fsPath":"docs/dev-docs/setup-rebilly-instruments-ach.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set up ACH","link":"/docs/dev-docs/setup-rebilly-instruments-ach","routeSlug":"/docs/dev-docs/setup-rebilly-instruments-ach"}]},{"type":"link","fsPath":"docs/dev-docs/reference-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Reference","link":"/docs/dev-docs/reference-rebilly-instruments","routeSlug":"/docs/dev-docs/reference-rebilly-instruments"},{"type":"link","fsPath":"docs/dev-docs/payment-methods-supported-by-rebilly-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Supported payment methods","link":"/docs/dev-docs/payment-methods-supported-by-rebilly-instruments","routeSlug":"/docs/dev-docs/payment-methods-supported-by-rebilly-instruments"}]},{"type":"group","fsPath":"docs/dev-docs/deposits-and-payouts.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Deposit & withdrawal forms","link":"/docs/dev-docs/deposits-and-payouts","routeSlug":"/docs/dev-docs/deposits-and-payouts","items":[{"type":"link","fsPath":"docs/dev-docs/integrate-a-deposit-form.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate a deposit form","link":"/docs/dev-docs/integrate-a-deposit-form","routeSlug":"/docs/dev-docs/integrate-a-deposit-form"},{"type":"link","fsPath":"docs/dev-docs/integrate-an-express-deposit.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate an express deposit","link":"/docs/dev-docs/integrate-an-express-deposit","routeSlug":"/docs/dev-docs/integrate-an-express-deposit"},{"type":"link","fsPath":"docs/dev-docs/integrate-a-withdrawal-form.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate a withdrawal form","link":"/docs/dev-docs/integrate-a-withdrawal-form","routeSlug":"/docs/dev-docs/integrate-a-withdrawal-form"},{"type":"link","fsPath":"docs/dev-docs/integrate-a-reverse-withdraw-form.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate a reverse withdrawal form","link":"/docs/dev-docs/integrate-a-reverse-withdraw-form","routeSlug":"/docs/dev-docs/integrate-a-reverse-withdraw-form"},{"type":"link","fsPath":"docs/dev-docs/integrate-a-cashier-form.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Integrate a cashier form","link":"/docs/dev-docs/integrate-a-cashier-form","routeSlug":"/docs/dev-docs/integrate-a-cashier-form"},{"type":"link","fsPath":"docs/dev-docs/customize-rebilly-cashier.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customize","link":"/docs/dev-docs/customize-rebilly-cashier","routeSlug":"/docs/dev-docs/customize-rebilly-cashier"},{"type":"link","fsPath":"docs/dev-docs/reference-rebilly-cashier.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Reference","link":"/docs/dev-docs/reference-rebilly-cashier","routeSlug":"/docs/dev-docs/reference-rebilly-cashier"}]},{"type":"link","fsPath":"docs/dev-docs/create-a-customer.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Create a customer","link":"/docs/dev-docs/create-a-customer","routeSlug":"/docs/dev-docs/create-a-customer"},{"type":"link","fsPath":"docs/dev-docs/digital-wallets.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Digital wallets","link":"/docs/dev-docs/digital-wallets","routeSlug":"/docs/dev-docs/digital-wallets"}]},{"type":"link","fsPath":"docs/dev-docs/set-up-environment.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Set up your environment","link":"/docs/dev-docs/set-up-environment","routeSlug":"/docs/dev-docs/set-up-environment"},{"type":"group","fsPath":"docs/dev-docs/concepts.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Concepts","link":"/docs/dev-docs/concepts","routeSlug":"/docs/dev-docs/concepts","items":[{"type":"link","fsPath":"docs/dev-docs/customers.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customers","link":"/docs/dev-docs/customers","routeSlug":"/docs/dev-docs/customers"},{"type":"link","fsPath":"docs/dev-docs/payment-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payment instruments","link":"/docs/dev-docs/payment-instruments","routeSlug":"/docs/dev-docs/payment-instruments"},{"type":"group","fsPath":"docs/dev-docs/transactions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Transactions","link":"/docs/dev-docs/transactions","routeSlug":"/docs/dev-docs/transactions","items":[{"type":"link","fsPath":"docs/dev-docs/customer-initiated-and-merchant-initiated-transactions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Customer-initiated and merchant-initiated transactions","link":"/docs/dev-docs/customer-initiated-and-merchant-initiated-transactions","routeSlug":"/docs/dev-docs/customer-initiated-and-merchant-initiated-transactions"}]},{"type":"group","fsPath":"docs/dev-docs/orders.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Orders","link":"/docs/dev-docs/orders","routeSlug":"/docs/dev-docs/orders","items":[{"type":"link","fsPath":"docs/dev-docs/one-time-sales.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"One-time sales","link":"/docs/dev-docs/one-time-sales","routeSlug":"/docs/dev-docs/one-time-sales"},{"type":"link","fsPath":"docs/dev-docs/subscriptions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Subscriptions","link":"/docs/dev-docs/subscriptions","routeSlug":"/docs/dev-docs/subscriptions"}]},{"type":"link","fsPath":"docs/dev-docs/invoices.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Invoices","link":"/docs/dev-docs/invoices","routeSlug":"/docs/dev-docs/invoices"},{"type":"link","fsPath":"docs/dev-docs/quotes.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Quotes","link":"/docs/dev-docs/quotes","routeSlug":"/docs/dev-docs/quotes"},{"type":"link","fsPath":"docs/dev-docs/credit-memos.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Credit memos","link":"/docs/dev-docs/credit-memos","routeSlug":"/docs/dev-docs/credit-memos"},{"type":"link","fsPath":"docs/dev-docs/payout-requests.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Payout requests","link":"/docs/dev-docs/payout-requests","routeSlug":"/docs/dev-docs/payout-requests"},{"type":"link","fsPath":"docs/dev-docs/products-and-plans.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Products & plans","link":"/docs/dev-docs/products-and-plans","routeSlug":"/docs/dev-docs/products-and-plans"},{"type":"link","fsPath":"docs/dev-docs/organizations-and-websites.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Organizations & websites","link":"/docs/dev-docs/organizations-and-websites","routeSlug":"/docs/dev-docs/organizations-and-websites"},{"type":"link","fsPath":"docs/dev-docs/deposit-requests.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Deposit requests","link":"/docs/dev-docs/deposit-requests","routeSlug":"/docs/dev-docs/deposit-requests"},{"type":"link","fsPath":"docs/dev-docs/balance-transactions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Balance transactions","link":"/docs/dev-docs/balance-transactions","routeSlug":"/docs/dev-docs/balance-transactions"},{"type":"link","fsPath":"docs/dev-docs/automations.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Automation","link":"/docs/dev-docs/automations","routeSlug":"/docs/dev-docs/automations"}]},{"type":"separator","label":"Libraries and SDKs"},{"type":"group","fsPath":"docs/dev-docs/framepay.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"FramePay","link":"/docs/dev-docs/framepay","routeSlug":"/docs/dev-docs/framepay","items":[{"type":"group","fsPath":"docs/dev-docs/basic-setup.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Get started","link":"/docs/dev-docs/basic-setup","routeSlug":"/docs/dev-docs/basic-setup","items":[{"type":"link","fsPath":"docs/dev-docs/install-framepay.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Install FramePay","link":"/docs/dev-docs/install-framepay","routeSlug":"/docs/dev-docs/install-framepay"},{"type":"link","fsPath":"docs/dev-docs/setup-payment-card-method.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment card data","link":"/docs/dev-docs/setup-payment-card-method","routeSlug":"/docs/dev-docs/setup-payment-card-method"},{"type":"link","fsPath":"docs/dev-docs/setup-bank-method.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from a bank account","link":"/docs/dev-docs/setup-bank-method","routeSlug":"/docs/dev-docs/setup-bank-method"},{"type":"link","fsPath":"docs/dev-docs/setup-google-pay.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from Google Pay™","link":"/docs/dev-docs/setup-google-pay","routeSlug":"/docs/dev-docs/setup-google-pay"},{"type":"link","fsPath":"docs/dev-docs/setup-apple-pay.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from Apple Pay","link":"/docs/dev-docs/setup-apple-pay","routeSlug":"/docs/dev-docs/setup-apple-pay"},{"type":"link","fsPath":"docs/dev-docs/setup-samsung-pay.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from Samsung Pay","link":"/docs/dev-docs/setup-samsung-pay","routeSlug":"/docs/dev-docs/setup-samsung-pay"},{"type":"link","fsPath":"docs/dev-docs/setup-paypal-method.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from PayPal","link":"/docs/dev-docs/setup-paypal-method","routeSlug":"/docs/dev-docs/setup-paypal-method"},{"type":"link","fsPath":"docs/dev-docs/setup-plaid-method.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from Plaid","link":"/docs/dev-docs/setup-plaid-method","routeSlug":"/docs/dev-docs/setup-plaid-method"},{"type":"link","fsPath":"docs/dev-docs/setup-klarna-method.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from Klarna BNPL","link":"/docs/dev-docs/setup-klarna-method","routeSlug":"/docs/dev-docs/setup-klarna-method"},{"type":"link","fsPath":"docs/dev-docs/setup-multiple-payment-methods.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Tokenize payment data from multiple payment methods","link":"/docs/dev-docs/setup-multiple-payment-methods","routeSlug":"/docs/dev-docs/setup-multiple-payment-methods"},{"type":"link","fsPath":"docs/dev-docs/end-to-end-framepay-example.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"End-to-end FramePay integration","link":"/docs/dev-docs/end-to-end-framepay-example","routeSlug":"/docs/dev-docs/end-to-end-framepay-example"}],"expanded":"true"},{"type":"link","fsPath":"docs/dev-docs/form-setup.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Form set up","link":"/docs/dev-docs/form-setup","routeSlug":"/docs/dev-docs/form-setup"},{"type":"link","fsPath":"docs/dev-docs/events.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Events","link":"/docs/dev-docs/events","routeSlug":"/docs/dev-docs/events"},{"type":"group","label":"Advanced features","items":[{"type":"link","fsPath":"docs/dev-docs/update-payment-instruments.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Update payment instruments","link":"/docs/dev-docs/update-payment-instruments","routeSlug":"/docs/dev-docs/update-payment-instruments"},{"type":"link","fsPath":"docs/dev-docs/define-lead-source-data.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Define lead source data","link":"/docs/dev-docs/define-lead-source-data","routeSlug":"/docs/dev-docs/define-lead-source-data"},{"type":"link","fsPath":"docs/dev-docs/framepay-global-reference.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"FramePay reference methods","link":"/docs/dev-docs/framepay-global-reference","routeSlug":"/docs/dev-docs/framepay-global-reference"},{"type":"link","fsPath":"docs/dev-docs/shipping-configuration-in-express-methods.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Shipping configuration","link":"/docs/dev-docs/shipping-configuration-in-express-methods","routeSlug":"/docs/dev-docs/shipping-configuration-in-express-methods"},{"type":"link","fsPath":"docs/dev-docs/use-framepay-encrypted-cvv.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Use encrypted CVVs for payment instruments","link":"/docs/dev-docs/use-framepay-encrypted-cvv","routeSlug":"/docs/dev-docs/use-framepay-encrypted-cvv"}]},{"type":"link","fsPath":"docs/dev-docs/framepay-configuration-reference.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Configuration reference","link":"/docs/dev-docs/framepay-configuration-reference","routeSlug":"/docs/dev-docs/framepay-configuration-reference"},{"type":"link","fsPath":"docs/dev-docs/examples.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Examples","link":"/docs/dev-docs/examples","routeSlug":"/docs/dev-docs/examples"},{"type":"link","fsPath":"docs/dev-docs/element.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Element","link":"/docs/dev-docs/element","routeSlug":"/docs/dev-docs/element"},{"type":"link","fsPath":"docs/dev-docs/supported-browsers.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Supported browsers","link":"/docs/dev-docs/supported-browsers","routeSlug":"/docs/dev-docs/supported-browsers"}]},{"type":"group","fsPath":"docs/dev-docs/sdks.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"SDKs","link":"/docs/dev-docs/sdks","routeSlug":"/docs/dev-docs/sdks","items":[{"type":"group","fsPath":"docs/dev-docs/js-sdk-quickstart.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"JS SDK","link":"/docs/dev-docs/js-sdk-quickstart","routeSlug":"/docs/dev-docs/js-sdk-quickstart","items":[{"type":"link","fsPath":"docs/dev-docs/js-sdk-quickstart.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Quickstart","link":"/docs/dev-docs/js-sdk-quickstart","routeSlug":"/docs/dev-docs/js-sdk-quickstart"},{"type":"link","fsPath":"docs/dev-docs/reference.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"FramePay SDK reference","link":"/docs/dev-docs/reference","routeSlug":"/docs/dev-docs/reference"},{"type":"link","fsPath":"docs/dev-docs/api-client-methods.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"API client methods","link":"/docs/dev-docs/api-client-methods","routeSlug":"/docs/dev-docs/api-client-methods"}]}]},{"type":"separator","label":"API guides and reference"},{"type":"link","fsPath":"docs/dev-docs/api-keys.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"API keys","link":"/docs/dev-docs/api-keys","routeSlug":"/docs/dev-docs/api-keys"},{"type":"group","label":"Rebilly API","items":[{"type":"link","label":"Core APIs","link":"/docs/dev-docs/api","routeSlug":"/docs/dev-docs/api"},{"type":"link","label":"Introduction","link":"/docs/dev-docs/api/section/introduction","routeSlug":"/docs/dev-docs/api/section/introduction"},{"type":"group","label":"Authentication","link":"/docs/dev-docs/api/section/authentication","routeSlug":"/docs/dev-docs/api/section/authentication","items":[{"type":"link","label":"Manage API keys","link":"/docs/dev-docs/api/section/authentication/manage-api-keys","routeSlug":"/docs/dev-docs/api/section/authentication/manage-api-keys"}]},{"type":"link","label":"Errors","link":"/docs/dev-docs/api/section/errors","routeSlug":"/docs/dev-docs/api/section/errors"},{"type":"group","label":"SDKs","link":"/docs/dev-docs/api/section/sdks","routeSlug":"/docs/dev-docs/api/section/sdks","items":[{"type":"link","label":"JavaScript SDK","link":"/docs/dev-docs/api/section/sdks/javascript-sdk","routeSlug":"/docs/dev-docs/api/section/sdks/javascript-sdk"},{"type":"link","label":"PHP SDK","link":"/docs/dev-docs/api/section/sdks/php-sdk","routeSlug":"/docs/dev-docs/api/section/sdks/php-sdk"}]},{"type":"link","label":"Get started","link":"/docs/dev-docs/api/section/get-started","routeSlug":"/docs/dev-docs/api/section/get-started"},{"type":"link","label":"Rate limits","link":"/docs/dev-docs/api/section/rate-limits","routeSlug":"/docs/dev-docs/api/section/rate-limits"},{"type":"separator","label":"Customers"},{"type":"group","label":"Customers","link":"/docs/dev-docs/api/customers","routeSlug":"/docs/dev-docs/api/customers","items":[{"label":"Retrieve customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomercollection","routeSlug":"/docs/dev-docs/api/customers/getcustomercollection","metadata":{"seo":{"title":"Retrieve customers","description":"Retrieves a list of customers."}},"httpPath":"/customers"},{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/postcustomer","routeSlug":"/docs/dev-docs/api/customers/postcustomer","metadata":{"seo":{"title":"Create a customer","description":"Creates a new customer and customer ID."}},"httpPath":"/customers"},{"label":"Retrieve a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomer","routeSlug":"/docs/dev-docs/api/customers/getcustomer","metadata":{"seo":{"title":"Retrieve a customer","description":"Retrieves a customer with a specified ID."}},"httpPath":"/customers/{id}"},{"label":"Upsert a customer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/putcustomer","routeSlug":"/docs/dev-docs/api/customers/putcustomer","metadata":{"seo":{"title":"Upsert a customer","description":"Creates or updates (upserts) a customer with a specified ID."}},"httpPath":"/customers/{id}"},{"label":"Merge and delete a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/deletecustomer","routeSlug":"/docs/dev-docs/api/customers/deletecustomer","metadata":{"seo":{"title":"Merge and delete a customer","description":"Merges one duplicate customer to another target customer and deletes the former."}},"httpPath":"/customers/{id}"},{"label":"Retrieve a customer's lead source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomerleadsource","routeSlug":"/docs/dev-docs/api/customers/getcustomerleadsource","metadata":{"seo":{"title":"Retrieve a customer's lead source","description":"Retrieves lead source data for a customer with a specified ID."}},"httpPath":"/customers/{id}/lead-source"},{"label":"Create a customer's lead source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/putcustomerleadsource","routeSlug":"/docs/dev-docs/api/customers/putcustomerleadsource","metadata":{"seo":{"title":"Create a customer's lead source","description":"Creates a lead source for a customer with a specified ID."}},"httpPath":"/customers/{id}/lead-source"},{"label":"Delete a customer's lead source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/deletecustomerleadsource","routeSlug":"/docs/dev-docs/api/customers/deletecustomerleadsource","metadata":{"seo":{"title":"Delete a customer's lead source","description":"Deletes lead source data for a customer with a specified ID."}},"httpPath":"/customers/{id}/lead-source"},{"label":"Retrieve customer credit balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomercreditbalance","routeSlug":"/docs/dev-docs/api/customers/getcustomercreditbalance","metadata":{"seo":{"title":"Retrieve customer credit balance","description":"Retrieves a customer's credit balance grouped by currency."}},"httpPath":"/customers/{id}/credit-balance"},{"label":"Create a compliance screening report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/postcustomercompliancescreeningreport","routeSlug":"/docs/dev-docs/api/customers/postcustomercompliancescreeningreport","metadata":{"seo":{"title":"Create a compliance screening report","description":"Creates a compliance screening report that includes Know Your Customer (KYC) and Anti-Money Laundering (AML) results for a customer. The report is stored as a PDF customer attachment. Requires the KYC and AML products to be enabled for the organization."}},"httpPath":"/customers/{id}/compliance-screening-report"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Customer created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-created","routeSlug":"/docs/dev-docs/api/customers/customer-created","metadata":{"seo":{"title":"Customer created","description":"Customer created"}},"httpPath":"customer-created"},{"label":"Customer merged","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-merged","routeSlug":"/docs/dev-docs/api/customers/customer-merged","metadata":{"seo":{"title":"Customer merged","description":"Customer merged"}},"httpPath":"customer-merged"},{"label":"Customer one-time-password requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-one-time-password-requested","routeSlug":"/docs/dev-docs/api/customers/customer-one-time-password-requested","metadata":{"seo":{"title":"Customer one-time-password requested","description":"Customer one-time-password requested"}},"httpPath":"customer-one-time-password-requested"},{"label":"Customer tax number validated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-tax-number-validated","routeSlug":"/docs/dev-docs/api/customers/customer-tax-number-validated","metadata":{"seo":{"title":"Customer tax number validated","description":"Customer tax number validated"}},"httpPath":"customer-tax-number-validated"},{"label":"Customer updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-updated","routeSlug":"/docs/dev-docs/api/customers/customer-updated","metadata":{"seo":{"title":"Customer updated","description":"Customer updated"}},"httpPath":"customer-updated"},{"label":"Experian check performed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/experian-check-performed","routeSlug":"/docs/dev-docs/api/customers/experian-check-performed","metadata":{"seo":{"title":"Experian check performed","description":"Experian check performed"}},"httpPath":"experian-check-performed"},{"label":"Lead source changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/lead-source-changed","routeSlug":"/docs/dev-docs/api/customers/lead-source-changed","metadata":{"seo":{"title":"Lead source changed","description":"Lead source changed"}},"httpPath":"lead-source-changed"}]},{"type":"group","label":"Customer authentication","link":"/docs/dev-docs/api/customer-authentication","routeSlug":"/docs/dev-docs/api/customer-authentication","items":[{"label":"Retrieve authentication options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getauthenticationoption","routeSlug":"/docs/dev-docs/api/customer-authentication/getauthenticationoption","metadata":{"seo":{"title":"Retrieve authentication options","description":"Retrieves customer authentication options."}},"httpPath":"/authentication-options"},{"label":"Change authentication options","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/putauthenticationoption","routeSlug":"/docs/dev-docs/api/customer-authentication/putauthenticationoption","metadata":{"seo":{"title":"Change authentication options","description":"Changes customer authentication options."}},"httpPath":"/authentication-options"},{"label":"Retrieve authentication tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getauthenticationtokencollection","routeSlug":"/docs/dev-docs/api/customer-authentication/getauthenticationtokencollection","metadata":{"seo":{"title":"Retrieve authentication tokens","description":"Retrieves a list of customer authentication tokens."}},"httpPath":"/authentication-tokens"},{"label":"Login a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postauthenticationtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/postauthenticationtoken","metadata":{"seo":{"title":"Login a customer","description":"Logs in a customer."}},"httpPath":"/authentication-tokens"},{"label":"Verify an authentication token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getauthenticationtokenverification","routeSlug":"/docs/dev-docs/api/customer-authentication/getauthenticationtokenverification","metadata":{"seo":{"title":"Verify an authentication token","description":"Verifies a customer's authentication token."}},"httpPath":"/authentication-tokens/{token}"},{"label":"Logout a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/deleteauthenticationtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/deleteauthenticationtoken","metadata":{"seo":{"title":"Logout a customer","description":"Logs out a customer."}},"httpPath":"/authentication-tokens/{token}"},{"label":"Exchange an authentication token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postauthenticationtokenexchange","routeSlug":"/docs/dev-docs/api/customer-authentication/postauthenticationtokenexchange","metadata":{"seo":{"title":"Exchange an authentication token","description":"Exchanges an authentication token for a JWT."}},"httpPath":"/authentication-tokens/{token}/exchange"},{"label":"Retrieve credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getcredentialcollection","routeSlug":"/docs/dev-docs/api/customer-authentication/getcredentialcollection","metadata":{"seo":{"title":"Retrieve credentials","description":"Retrieves a list of authentication credentials."}},"httpPath":"/credentials"},{"label":"Create a credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postcredential","routeSlug":"/docs/dev-docs/api/customer-authentication/postcredential","metadata":{"seo":{"title":"Create a credential","description":"Creates an authentication credential."}},"httpPath":"/credentials"},{"label":"Retrieve a credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getcredential","routeSlug":"/docs/dev-docs/api/customer-authentication/getcredential","metadata":{"seo":{"title":"Retrieve a credential","description":"Retrieves a credential with a specified ID."}},"httpPath":"/credentials/{id}"},{"label":"Upsert a credential","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/putcredential","routeSlug":"/docs/dev-docs/api/customer-authentication/putcredential","metadata":{"seo":{"title":"Upsert a credential","description":"Creates or updates (upserts) an authentication credential with a specified ID."}},"httpPath":"/credentials/{id}"},{"label":"Delete a credential","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/deletecredential","routeSlug":"/docs/dev-docs/api/customer-authentication/deletecredential","metadata":{"seo":{"title":"Delete a credential","description":"Deletes an authentication credential with a specified ID."}},"httpPath":"/credentials/{id}"},{"label":"Retrieve tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getpasswordtokencollection","routeSlug":"/docs/dev-docs/api/customer-authentication/getpasswordtokencollection","metadata":{"seo":{"title":"Retrieve tokens","description":"Retrieves a list of reset password tokens."}},"httpPath":"/password-tokens"},{"label":"Create a reset password token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postpasswordtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/postpasswordtoken","metadata":{"seo":{"title":"Create a reset password token","description":"Creates a reset password token."}},"httpPath":"/password-tokens"},{"label":"Retrieve a reset password token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getpasswordtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/getpasswordtoken","metadata":{"seo":{"title":"Retrieve a reset password token","description":"Retrieves a reset password token with a specified ID."}},"httpPath":"/password-tokens/{id}"},{"label":"Delete a reset password token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/deletepasswordtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/deletepasswordtoken","metadata":{"seo":{"title":"Delete a reset password token","description":"Deletes a reset password token with a specified ID."}},"httpPath":"/password-tokens/{id}"}]},{"type":"group","label":"Account registration settings","link":"/docs/dev-docs/api/account-registration-settings","routeSlug":"/docs/dev-docs/api/account-registration-settings","items":[{"label":"Retrieve account registration settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettingscollection","routeSlug":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettingscollection","metadata":{"seo":{"title":"Retrieve account registration settings","description":"Retrieves a list of all account registration settings."}},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings"},{"label":"Create account registration settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/postaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/postaccountregistrationsettings","metadata":{"seo":{"title":"Create account registration settings","description":"Creates a new account registration settings resource."}},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings"},{"label":"Retrieve account registration settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettings","metadata":{"seo":{"title":"Retrieve account registration settings","description":"Retrieves account registration settings with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings/{id}"},{"label":"Upsert account registration settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/putaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/putaccountregistrationsettings","metadata":{"seo":{"title":"Upsert account registration settings","description":"Creates or updates account registration settings with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings/{id}"},{"label":"Delete account registration settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/deleteaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/deleteaccountregistrationsettings","metadata":{"seo":{"title":"Delete account registration settings","description":"Deletes account registration settings with a specified ID. Default account registration settings cannot be deleted."}},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings/{id}"}]},{"type":"group","label":"Tags","link":"/docs/dev-docs/api/tags","routeSlug":"/docs/dev-docs/api/tags","items":[{"label":"Retrieve tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettagcollection","routeSlug":"/docs/dev-docs/api/tags/gettagcollection","metadata":{"seo":{"title":"Retrieve tags","description":"Retrieves a list of tags."}},"httpPath":"/tags"},{"label":"Create a tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttag","routeSlug":"/docs/dev-docs/api/tags/posttag","metadata":{"seo":{"title":"Create a tag","description":"Creates a tag."}},"httpPath":"/tags"},{"label":"Retrieve a tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettag","routeSlug":"/docs/dev-docs/api/tags/gettag","metadata":{"seo":{"title":"Retrieve a tag","description":"Retrieves a tag with a specified name."}},"httpPath":"/tags/{tag}"},{"label":"Update a tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/patchtag","routeSlug":"/docs/dev-docs/api/tags/patchtag","metadata":{"seo":{"title":"Update a tag","description":"Updates a tag with a specified name."}},"httpPath":"/tags/{tag}"},{"label":"Delete a tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetag","routeSlug":"/docs/dev-docs/api/tags/deletetag","metadata":{"seo":{"title":"Delete a tag","description":"Deletes a tag with a specified name. This is an asynchronous operation."}},"httpPath":"/tags/{tag}"},{"label":"Tag a list of customers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagcustomercollection","routeSlug":"/docs/dev-docs/api/tags/posttagcustomercollection","metadata":{"seo":{"title":"Tag a list of customers","description":"Tags a list of customers."}},"httpPath":"/tags/{tag}/customers"},{"label":"Untag a list of customers","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagcustomercollection","routeSlug":"/docs/dev-docs/api/tags/deletetagcustomercollection","metadata":{"seo":{"title":"Untag a list of customers","description":"Untag a list of customers."}},"httpPath":"/tags/{tag}/customers"},{"label":"Tag a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagcustomer","routeSlug":"/docs/dev-docs/api/tags/posttagcustomer","metadata":{"seo":{"title":"Tag a customer","description":"Tags a customer."}},"httpPath":"/tags/{tag}/customers/{customerId}"},{"label":"Untag a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagcustomer","routeSlug":"/docs/dev-docs/api/tags/deletetagcustomer","metadata":{"seo":{"title":"Untag a customer","description":"Untags a customer."}},"httpPath":"/tags/{tag}/customers/{customerId}"},{"label":"Tag a list of KYC documents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagkycdocumentcollection","routeSlug":"/docs/dev-docs/api/tags/posttagkycdocumentcollection","metadata":{"seo":{"title":"Tag a list of KYC documents","description":"Tags a list of KYC documents."}},"httpPath":"/tags/{tag}/kyc-documents"},{"label":"Untag a list of KYC documents","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagkycdocumentcollection","routeSlug":"/docs/dev-docs/api/tags/deletetagkycdocumentcollection","metadata":{"seo":{"title":"Untag a list of KYC documents","description":"Untags a list of KYC documents."}},"httpPath":"/tags/{tag}/kyc-documents"},{"label":"Tag a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagkycdocument","routeSlug":"/docs/dev-docs/api/tags/posttagkycdocument","metadata":{"seo":{"title":"Tag a KYC document","description":"Tags a KYC document."}},"httpPath":"/tags/{tag}/kyc-documents/{kycDocumentId}"},{"label":"Untag a KYC document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagkycdocument","routeSlug":"/docs/dev-docs/api/tags/deletetagkycdocument","metadata":{"seo":{"title":"Untag a KYC document","description":"Untags a KYC document."}},"httpPath":"/tags/{tag}/kyc-documents/{kycDocumentId}"},{"label":"Tag a list of AML checks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagamlcheckcollection","routeSlug":"/docs/dev-docs/api/tags/posttagamlcheckcollection","metadata":{"seo":{"title":"Tag a list of AML checks","description":"Tags a list of AML checks."}},"httpPath":"/tags/{tag}/aml-checks"},{"label":"Untag a list of AML checks","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagamlcheckcollection","routeSlug":"/docs/dev-docs/api/tags/deletetagamlcheckcollection","metadata":{"seo":{"title":"Untag a list of AML checks","description":"Untags a list of AML checks."}},"httpPath":"/tags/{tag}/aml-checks"},{"label":"Tag an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagamlcheck","routeSlug":"/docs/dev-docs/api/tags/posttagamlcheck","metadata":{"seo":{"title":"Tag an AML check","description":"Tags an AML check."}},"httpPath":"/tags/{tag}/aml-checks/{amlCheckId}"},{"label":"Untag an AML check","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagamlcheck","routeSlug":"/docs/dev-docs/api/tags/deletetagamlcheck","metadata":{"seo":{"title":"Untag an AML check","description":"Untags an AML check."}},"httpPath":"/tags/{tag}/aml-checks/{amlCheckId}"},{"label":"Retrieve tags rules list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettagrulecollection","routeSlug":"/docs/dev-docs/api/tags/gettagrulecollection","metadata":{"seo":{"title":"Retrieve tags rules list","description":"Retrieves a list of tags rules."}},"httpPath":"/tags-rules"},{"label":"Create tags rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagrule","routeSlug":"/docs/dev-docs/api/tags/posttagrule","metadata":{"seo":{"title":"Create tags rule","description":"Creates a tags rule."}},"httpPath":"/tags-rules"},{"label":"Retrieve a tags rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettagrule","routeSlug":"/docs/dev-docs/api/tags/gettagrule","metadata":{"seo":{"title":"Retrieve a tags rule","description":"Retrieves a tags rule with a specified ID."}},"httpPath":"/tags-rules/{id}"},{"label":"Create a tags rule with specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/puttagrule","routeSlug":"/docs/dev-docs/api/tags/puttagrule","metadata":{"seo":{"title":"Create a tags rule with specified ID","description":"Creates a tags rule with a specified ID."}},"httpPath":"/tags-rules/{id}"},{"label":"Delete tags rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagrule","routeSlug":"/docs/dev-docs/api/tags/deletetagrule","metadata":{"seo":{"title":"Delete tags rule","description":"Deletes a tags rule with a specified ID."}},"httpPath":"/tags-rules/{id}"}]},{"type":"group","label":"Customers timeline","link":"/docs/dev-docs/api/customers-timeline","routeSlug":"/docs/dev-docs/api/customers-timeline","items":[{"label":"Retrieve customer timeline custom event types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtypecollection","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtypecollection","metadata":{"seo":{"title":"Retrieve customer timeline custom event types","description":"Retrieves a list of customer timeline custom event types."}},"httpPath":"/customer-timeline-custom-events"},{"label":"Create customer timeline custom event type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/postcustomertimelinecustomeventtype","routeSlug":"/docs/dev-docs/api/customers-timeline/postcustomertimelinecustomeventtype","metadata":{"seo":{"title":"Create customer timeline custom event type","description":"Creates a customer timeline custom event type."}},"httpPath":"/customer-timeline-custom-events"},{"label":"Retrieve customer timeline custom event type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtype","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtype","metadata":{"seo":{"title":"Retrieve customer timeline custom event type","description":"Retrieves a customer timeline custom event type with a specified ID."}},"httpPath":"/customer-timeline-custom-events/{id}"},{"label":"Retrieve customer timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecollection","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecollection","metadata":{"seo":{"title":"Retrieve customer timeline messages","description":"Retrieves customer timeline messages."}},"httpPath":"/customers/{id}/timeline"},{"label":"Create a customer timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/postcustomertimeline","routeSlug":"/docs/dev-docs/api/customers-timeline/postcustomertimeline","metadata":{"seo":{"title":"Create a customer timeline comment","description":"Creates a customer timeline comment or custom defined event."}},"httpPath":"/customers/{id}/timeline"},{"label":"Retrieve a customer timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimeline","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimeline","metadata":{"seo":{"title":"Retrieve a customer timeline message","description":"Retrieves a customer message with a specified ID."}},"httpPath":"/customers/{id}/timeline/{messageId}"},{"label":"Delete a customer timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/deletecustomertimeline","routeSlug":"/docs/dev-docs/api/customers-timeline/deletecustomertimeline","metadata":{"seo":{"title":"Delete a customer timeline message","description":"Deletes a customer timeline message with a specified ID."}},"httpPath":"/customers/{id}/timeline/{messageId}"}]},{"type":"separator","label":"Payment Instruments"},{"type":"group","label":"Payment instruments","link":"/docs/dev-docs/api/payment-instruments","routeSlug":"/docs/dev-docs/api/payment-instruments","items":[{"label":"Retrieve payment instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/getpaymentinstrumentcollection","routeSlug":"/docs/dev-docs/api/payment-instruments/getpaymentinstrumentcollection","metadata":{"seo":{"title":"Retrieve payment instruments","description":"Retrieves a list of payment instruments."}},"httpPath":"/payment-instruments"},{"label":"Create a payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/postpaymentinstrument","routeSlug":"/docs/dev-docs/api/payment-instruments/postpaymentinstrument","metadata":{"seo":{"title":"Create a payment instrument","description":"Creates a payment instrument. If the payment card, bank account, or alternative payment instrument already exists it is updated."}},"httpPath":"/payment-instruments"},{"label":"Retrieve a payment instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/getpaymentinstrument","routeSlug":"/docs/dev-docs/api/payment-instruments/getpaymentinstrument","metadata":{"seo":{"title":"Retrieve a payment instrument","description":"Retrieves a payment instrument with a specified ID."}},"httpPath":"/payment-instruments/{id}"},{"label":"Update payment instrument","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/patchpaymentinstrument","routeSlug":"/docs/dev-docs/api/payment-instruments/patchpaymentinstrument","metadata":{"seo":{"title":"Update payment instrument","description":"Updates the values of a payment instrument with a specified ID."}},"httpPath":"/payment-instruments/{id}"},{"label":"Deactivate a payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentdeactivation","routeSlug":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentdeactivation","metadata":{"seo":{"title":"Deactivate a payment instrument","description":"Deactivates a payment instrument with a specified ID."}},"httpPath":"/payment-instruments/{id}/deactivation"},{"label":"Verify name on a payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentnameinquiry","routeSlug":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentnameinquiry","metadata":{"seo":{"title":"Verify name on a payment instrument","description":"Performs a name check inquiry on a payment instrument. Use this operation to confirm the name that is associated with a payment instrument. This operation supports payment cards only, using VISA ANI requests through Worldpay."}},"httpPath":"/payment-instruments/{id}/name-inquiry"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Payment card created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-card-created","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-card-created","metadata":{"seo":{"title":"Payment card created","description":"Payment card created"}},"httpPath":"payment-card-created"},{"label":"Payment card expiration reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-card-expiration-reminder","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-card-expiration-reminder","metadata":{"seo":{"title":"Payment card expiration reminder","description":"Payment card expiration reminder"}},"httpPath":"payment-card-expiration-reminder"},{"label":"Payment card expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-card-expired","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-card-expired","metadata":{"seo":{"title":"Payment card expired","description":"Payment card expired"}},"httpPath":"payment-card-expired"},{"label":"Payment instrument modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-instrument-modified","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-instrument-modified","metadata":{"seo":{"title":"Payment instrument modified","description":"Payment instrument modified"}},"httpPath":"payment-instrument-modified"}]},{"type":"group","label":"Payment tokens","link":"/docs/dev-docs/api/payment-tokens","routeSlug":"/docs/dev-docs/api/payment-tokens","items":[{"label":"Create a payment token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/posttoken","routeSlug":"/docs/dev-docs/api/payment-tokens/posttoken","metadata":{"seo":{"title":"Create a payment token","description":"Creates a payment token which can be exchanged into a payment instrument.FramePay is the recommended way to create a payment token because it minimizes PCI DSS compliance.Once a payment token is created, it can only be used once."}},"httpPath":"/tokens"},{"label":"Retrieve tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/gettokencollection","routeSlug":"/docs/dev-docs/api/payment-tokens/gettokencollection","metadata":{"seo":{"title":"Retrieve tokens","description":"Retrieve a list of tokens."}},"httpPath":"/tokens"},{"label":"Retrieve a token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/gettoken","routeSlug":"/docs/dev-docs/api/payment-tokens/gettoken","metadata":{"seo":{"title":"Retrieve a token","description":"Retrieves a token with a specified ID."}},"httpPath":"/tokens/{token}"},{"label":"Validate a digital wallet session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/postdigitalwalletvalidation","routeSlug":"/docs/dev-docs/api/payment-tokens/postdigitalwalletvalidation","metadata":{"seo":{"title":"Validate a digital wallet session","description":"Validates a digital wallet session."}},"httpPath":"/digital-wallets/validation"}]},{"type":"separator","label":"Payments"},{"type":"group","label":"Transactions","link":"/docs/dev-docs/api/transactions","routeSlug":"/docs/dev-docs/api/transactions","items":[{"label":"Ready to pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postreadytopay","routeSlug":"/docs/dev-docs/api/transactions/postreadytopay","metadata":{"seo":{"title":"Ready to pay","description":"Retrieves available payment methods for a specific transaction or purchase."}},"httpPath":"/ready-to-pay"},{"label":"Create a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransaction","routeSlug":"/docs/dev-docs/api/transactions/posttransaction","metadata":{"seo":{"title":"Create a transaction","description":"Creates a transaction of type sale, authorize or setup."}},"httpPath":"/transactions"},{"label":"Retrieve transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/gettransactioncollection","routeSlug":"/docs/dev-docs/api/transactions/gettransactioncollection","metadata":{"seo":{"title":"Retrieve transactions","description":"Retrieves a list of transactions."}},"httpPath":"/transactions"},{"label":"Retrieve a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/gettransaction","routeSlug":"/docs/dev-docs/api/transactions/gettransaction","metadata":{"seo":{"title":"Retrieve a transaction","description":"Retrieves a transaction with a specified ID."}},"httpPath":"/transactions/{id}"},{"label":"Update a transaction","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchtransaction","routeSlug":"/docs/dev-docs/api/transactions/patchtransaction","metadata":{"seo":{"title":"Update a transaction","description":"Updates the custom fields of a transaction with a specified ID."}},"httpPath":"/transactions/{id}"},{"label":"Create a credit transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayout","routeSlug":"/docs/dev-docs/api/transactions/postpayout","metadata":{"seo":{"title":"Create a credit transaction","description":"Creates a transaction of type credit."}},"httpPath":"/payouts"},{"label":"Query a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransactionquery","routeSlug":"/docs/dev-docs/api/transactions/posttransactionquery","metadata":{"seo":{"title":"Query a transaction","description":"Queries a transaction with a specified ID."}},"httpPath":"/transactions/{id}/query"},{"label":"Update a transaction status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransactionupdate","routeSlug":"/docs/dev-docs/api/transactions/posttransactionupdate","metadata":{"seo":{"title":"Update a transaction status","description":"Updates the status of a transaction with a specified ID to completed,with a specified result and optional currency and amount values."}},"httpPath":"/transactions/{id}/update"},{"label":"Refund a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransactionrefund","routeSlug":"/docs/dev-docs/api/transactions/posttransactionrefund","metadata":{"seo":{"title":"Refund a transaction","description":"Refunds a transaction with a specified ID."}},"httpPath":"/transactions/{id}/refund"},{"label":"Retrieve payout requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestcollection","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestcollection","metadata":{"seo":{"title":"Retrieve payout requests","description":"Retrieves a list of payout requests."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests"},{"label":"Create a payout request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequest","metadata":{"seo":{"title":"Create a payout request","description":"Creates a payout request.In the response, the selectPaymentInstrumentUrl field is used to redirect the customer to select a preferred payment instrument.After a payment instrument is selected, the customer is redirected to the selectedPaymentInstrumentRedirectUrl value."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests"},{"label":"Retrieve a payout request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequest","metadata":{"seo":{"title":"Retrieve a payout request","description":"Retrieves a payout request with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}"},{"label":"Upsert a payout request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/putpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/putpayoutrequest","metadata":{"seo":{"title":"Upsert a payout request","description":"Creates or updates (upserts) a payout request with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}"},{"label":"Update a payout request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/patchpayoutrequest","metadata":{"seo":{"title":"Update a payout request","description":"Updates a payout request with a specified ID. Use this operation to update the status, description, and blocked state."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}"},{"label":"Cancel a payout request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestcancellation","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestcancellation","metadata":{"seo":{"title":"Cancel a payout request","description":"Cancels a payout request with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/cancel"},{"label":"Request a payout request split","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestsplit","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestsplit","metadata":{"seo":{"title":"Request a payout request split","description":"Splits a payout request that is in pending, ready, or approved status into two or more separate requests."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/split"},{"label":"Retrieve associated payment instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestpaymentinstruments","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestpaymentinstruments","metadata":{"seo":{"title":"Retrieve associated payment instruments","description":"Retrieves the payment gateway and a list of payment instruments that are associated with a payout request with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/payment-instruments"},{"label":"Retrieve payout request allocations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestallocationcollection","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestallocationcollection","metadata":{"seo":{"title":"Retrieve payout request allocations","description":"Retrieves a list of payout request allocations."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations"},{"label":"Create a payout request allocation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestallocation","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestallocation","metadata":{"seo":{"title":"Create a payout request allocation","description":"Creates an allocation for a payout request."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations"},{"label":"Create an automatic payout request allocation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestautoallocation","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestautoallocation","metadata":{"seo":{"title":"Create an automatic payout request allocation","description":"Creates an automatic payout request allocation using system-selected parameters.Only the payout request ID is required; all allocation details are determined automatically."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/auto"},{"label":"Retrieve a payout request allocation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestallocation","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestallocation","metadata":{"seo":{"title":"Retrieve a payout request allocation","description":"Retrieves a payout request allocation with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/{id}"},{"label":"Update allocation status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchpayoutrequestallocation","routeSlug":"/docs/dev-docs/api/transactions/patchpayoutrequestallocation","metadata":{"seo":{"title":"Update allocation status","description":"Updates the status of a payout request allocation with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/{id}"},{"label":"Initiate processing of allocations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestallocationsprocess","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestallocationsprocess","metadata":{"seo":{"title":"Initiate processing of allocations","description":"Initiates the processing of one or more payout request allocations."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/process"},{"label":"Retrieve payout request batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestbatchcollection","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestbatchcollection","metadata":{"seo":{"title":"Retrieve payout request batches","description":"Retrieves a list of payout request batches."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches"},{"label":"Create a payout request batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatch","metadata":{"seo":{"title":"Create a payout request batch","description":"Creates a batch of payout requests for batch processing."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches"},{"label":"Retrieve a payout request batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestbatch","metadata":{"seo":{"title":"Retrieve a payout request batch","description":"Retrieves a payout request batch with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}"},{"label":"Update a payout request batch","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchpayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/patchpayoutrequestbatch","metadata":{"seo":{"title":"Update a payout request batch","description":"Partially updates a payout request batch with a specified ID. Use this operation to update the description and allocation order."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}"},{"label":"Delete a payout request batch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/deletepayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/deletepayoutrequestbatch","metadata":{"seo":{"title":"Delete a payout request batch","description":"Deletes a payout request batch with a specified ID and clears the batchId field from every payout request in the batch.This operation preserves every payout request, status, and blocked state.This operation is atomic. It clears all batchId fields or leaves them all unchanged."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}"},{"label":"Allocate batch payout requests automatically","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchautoallocate","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchautoallocate","metadata":{"seo":{"title":"Allocate batch payout requests automatically","description":"Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/auto-allocate"},{"label":"Approve payout requests in a batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchapprove","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchapprove","metadata":{"seo":{"title":"Approve payout requests in a batch","description":"Approves all payout requests in a specified batch."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/approve"},{"label":"Block batch payout requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchblock","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchblock","metadata":{"seo":{"title":"Block batch payout requests","description":"Blocks all payout requests in a specified batch."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/block"},{"label":"Add requests to a payout request batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequeststobatch","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequeststobatch","metadata":{"seo":{"title":"Add requests to a payout request batch","description":"Adds payout requests to a batch with a specified ID.Accepts payout requests in any status, with or without allocations.A batch contains a maximum of 1000 payout requests."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/payout-requests"},{"label":"Remove requests from a payout request batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postremovepayoutrequestsfrombatch","routeSlug":"/docs/dev-docs/api/transactions/postremovepayoutrequestsfrombatch","metadata":{"seo":{"title":"Remove requests from a payout request batch","description":"Removes specified payout requests from a batch with a specified ID by clearing batchId on each request.This operation preserves each payout request, status, and blocked state.Removes requests regardless of status or allocations."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/payout-requests/remove"},{"label":"Unblock payout requests in a batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchunblock","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchunblock","metadata":{"seo":{"title":"Unblock payout requests in a batch","description":"Unblocks every blocked payout request in a batch with a specified ID. Leaves payout requests without a block unchanged. Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership. This operation is atomic."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/unblock"},{"label":"Preview payout request batch results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestbatchpreview","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestbatchpreview","metadata":{"seo":{"title":"Preview payout request batch results","description":"Retrieves aggregate information for the payout requests that match a specified filter."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/preview"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Customer redirected offsite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/customer-redirected-offsite","routeSlug":"/docs/dev-docs/api/transactions/customer-redirected-offsite","metadata":{"seo":{"title":"Customer redirected offsite","description":"Customer redirected offsite"}},"httpPath":"customer-redirected-offsite"},{"label":"Customer returned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/customer-returned","routeSlug":"/docs/dev-docs/api/transactions/customer-returned","metadata":{"seo":{"title":"Customer returned","description":"Customer returned"}},"httpPath":"customer-returned"},{"label":"Gateway account requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/gateway-account-requested","routeSlug":"/docs/dev-docs/api/transactions/gateway-account-requested","metadata":{"seo":{"title":"Gateway account requested","description":"Gateway account requested"}},"httpPath":"gateway-account-requested"},{"label":"Offsite payment completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/offsite-payment-completed","routeSlug":"/docs/dev-docs/api/transactions/offsite-payment-completed","metadata":{"seo":{"title":"Offsite payment completed","description":"Offsite payment completed"}},"httpPath":"offsite-payment-completed"},{"label":"Payout request canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-canceled","routeSlug":"/docs/dev-docs/api/transactions/payout-request-canceled","metadata":{"seo":{"title":"Payout request canceled","description":"Payout request canceled"}},"httpPath":"payout-request-canceled"},{"label":"Payout request created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-created","routeSlug":"/docs/dev-docs/api/transactions/payout-request-created","metadata":{"seo":{"title":"Payout request created","description":"Payout request created"}},"httpPath":"payout-request-created"},{"label":"Payout request fulfilled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-fulfilled","routeSlug":"/docs/dev-docs/api/transactions/payout-request-fulfilled","metadata":{"seo":{"title":"Payout request fulfilled","description":"Payout request fulfilled"}},"httpPath":"payout-request-fulfilled"},{"label":"Payout request modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-modified","routeSlug":"/docs/dev-docs/api/transactions/payout-request-modified","metadata":{"seo":{"title":"Payout request modified","description":"Payout request modified"}},"httpPath":"payout-request-modified"},{"label":"Ready to pay requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/ready-to-pay-requested","routeSlug":"/docs/dev-docs/api/transactions/ready-to-pay-requested","metadata":{"seo":{"title":"Ready to pay requested","description":"Ready to pay requested"}},"httpPath":"ready-to-pay-requested"},{"label":"Risk score changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/risk-score-changed","routeSlug":"/docs/dev-docs/api/transactions/risk-score-changed","metadata":{"seo":{"title":"Risk score changed","description":"Risk score changed"}},"httpPath":"risk-score-changed"},{"label":"Transaction amount discrepancy found","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-amount-discrepancy-found","routeSlug":"/docs/dev-docs/api/transactions/transaction-amount-discrepancy-found","metadata":{"seo":{"title":"Transaction amount discrepancy found","description":"Transaction amount discrepancy found"}},"httpPath":"transaction-amount-discrepancy-found"},{"label":"Transaction declined","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-declined","routeSlug":"/docs/dev-docs/api/transactions/transaction-declined","metadata":{"seo":{"title":"Transaction declined","description":"Transaction declined"}},"httpPath":"transaction-declined"},{"label":"Transaction discrepancy found","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-discrepancy-found","routeSlug":"/docs/dev-docs/api/transactions/transaction-discrepancy-found","metadata":{"seo":{"title":"Transaction discrepancy found","description":"Transaction discrepancy found"}},"httpPath":"transaction-discrepancy-found"},{"label":"Transaction process requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-process-requested","routeSlug":"/docs/dev-docs/api/transactions/transaction-process-requested","metadata":{"seo":{"title":"Transaction process requested","description":"Transaction process requested"}},"httpPath":"transaction-process-requested"},{"label":"Transaction processed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-processed","routeSlug":"/docs/dev-docs/api/transactions/transaction-processed","metadata":{"seo":{"title":"Transaction processed","description":"Transaction processed"}},"httpPath":"transaction-processed"},{"label":"Transaction reconciled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-reconciled","routeSlug":"/docs/dev-docs/api/transactions/transaction-reconciled","metadata":{"seo":{"title":"Transaction reconciled","description":"Transaction reconciled"}},"httpPath":"transaction-reconciled"},{"label":"Transaction partially refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-partially-refunded","routeSlug":"/docs/dev-docs/api/transactions/transaction-partially-refunded","metadata":{"seo":{"title":"Transaction partially refunded","description":"Transaction partially refunded"}},"httpPath":"transaction-partially-refunded"},{"label":"Transaction refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-refunded","routeSlug":"/docs/dev-docs/api/transactions/transaction-refunded","metadata":{"seo":{"title":"Transaction refunded","description":"Transaction refunded"}},"httpPath":"transaction-refunded"},{"label":"Transaction voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-voided","routeSlug":"/docs/dev-docs/api/transactions/transaction-voided","metadata":{"seo":{"title":"Transaction voided","description":"Transaction voided"}},"httpPath":"transaction-voided"},{"label":"Transaction timeout resolved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-timeout-resolved","routeSlug":"/docs/dev-docs/api/transactions/transaction-timeout-resolved","metadata":{"seo":{"title":"Transaction timeout resolved","description":"Transaction timeout resolved"}},"httpPath":"transaction-timeout-resolved"},{"label":"Waiting gateway transaction completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/waiting-gateway-transaction-completed","routeSlug":"/docs/dev-docs/api/transactions/waiting-gateway-transaction-completed","metadata":{"seo":{"title":"Waiting gateway transaction completed","description":"Waiting gateway transaction completed"}},"httpPath":"waiting-gateway-transaction-completed"},{"label":"Autodeposit lookup performed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/autodeposit-lookup-performed","routeSlug":"/docs/dev-docs/api/transactions/autodeposit-lookup-performed","metadata":{"seo":{"title":"Autodeposit lookup performed","description":"Autodeposit lookup performed"}},"httpPath":"autodeposit-lookup-performed"}]},{"type":"group","label":"Disputes","link":"/docs/dev-docs/api/disputes","routeSlug":"/docs/dev-docs/api/disputes","items":[{"label":"Retrieve disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/getdisputecollection","routeSlug":"/docs/dev-docs/api/disputes/getdisputecollection","metadata":{"seo":{"title":"Retrieve disputes","description":"Retrieves a list of all disputes."}},"httpPath":"/disputes"},{"label":"Create a dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/postdispute","routeSlug":"/docs/dev-docs/api/disputes/postdispute","metadata":{"seo":{"title":"Create a dispute","description":"Creates a new dispute."}},"httpPath":"/disputes"},{"label":"Retrieve a dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/getdispute","routeSlug":"/docs/dev-docs/api/disputes/getdispute","metadata":{"seo":{"title":"Retrieve a dispute","description":"Retrieves a dispute with a specified ID."}},"httpPath":"/disputes/{id}"},{"label":"Upsert a dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/putdispute","routeSlug":"/docs/dev-docs/api/disputes/putdispute","metadata":{"seo":{"title":"Upsert a dispute","description":"Creates or updates (upserts) a dispute with a specified ID."}},"httpPath":"/disputes/{id}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Dispute created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/disputes/dispute-created","routeSlug":"/docs/dev-docs/api/disputes/dispute-created","metadata":{"seo":{"title":"Dispute created","description":"Dispute created"}},"httpPath":"dispute-created"},{"label":"Dispute modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/disputes/dispute-modified","routeSlug":"/docs/dev-docs/api/disputes/dispute-modified","metadata":{"seo":{"title":"Dispute modified","description":"Dispute modified"}},"httpPath":"dispute-modified"}]},{"type":"group","label":"Fees","link":"/docs/dev-docs/api/fees","routeSlug":"/docs/dev-docs/api/fees","items":[{"label":"Retrieve fee entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/getfeecollection","routeSlug":"/docs/dev-docs/api/fees/getfeecollection","metadata":{"seo":{"title":"Retrieve fee entries","description":"Retrieves a list of fee entries."}},"badges":[{"name":"Experimental"}],"httpPath":"/fees"},{"label":"Create a fee entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/postfee","routeSlug":"/docs/dev-docs/api/fees/postfee","metadata":{"seo":{"title":"Create a fee entry","description":"Creates a fee entry."}},"badges":[{"name":"Experimental"}],"httpPath":"/fees"},{"label":"Retrieve a fee entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/getfee","routeSlug":"/docs/dev-docs/api/fees/getfee","metadata":{"seo":{"title":"Retrieve a fee entry","description":"Retrieves a fee entry."}},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"},{"label":"Upsert a fee entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/putfee","routeSlug":"/docs/dev-docs/api/fees/putfee","metadata":{"seo":{"title":"Upsert a fee entry","description":"Creates or updates (upserts) a fee entry."}},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"},{"label":"Patch a fee entry","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/patchfee","routeSlug":"/docs/dev-docs/api/fees/patchfee","metadata":{"seo":{"title":"Patch a fee entry","description":"Patches a fee entry."}},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"},{"label":"Delete a fee entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/deletefee","routeSlug":"/docs/dev-docs/api/fees/deletefee","metadata":{"seo":{"title":"Delete a fee entry","description":"Deletes a fee entry."}},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"}]},{"type":"group","label":"Transactions timeline","link":"/docs/dev-docs/api/transactions-timeline","routeSlug":"/docs/dev-docs/api/transactions-timeline","items":[{"label":"Retrieve transaction timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/gettransactiontimelinecollection","routeSlug":"/docs/dev-docs/api/transactions-timeline/gettransactiontimelinecollection","metadata":{"seo":{"title":"Retrieve transaction timeline messages","description":"Retrieves a list of transaction timeline messages."}},"httpPath":"/transactions/{id}/timeline"},{"label":"Create a transaction timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/posttransactiontimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/posttransactiontimeline","metadata":{"seo":{"title":"Create a transaction timeline comment","description":"Creates a transaction timeline comment."}},"httpPath":"/transactions/{id}/timeline"},{"label":"Retrieve a transaction Timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/gettransactiontimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/gettransactiontimeline","metadata":{"seo":{"title":"Retrieve a transaction Timeline message","description":"Retrieves a timeline message with a specified ID."}},"httpPath":"/transactions/{id}/timeline/{messageId}"},{"label":"Delete a transaction timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/deletetransactiontimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/deletetransactiontimeline","metadata":{"seo":{"title":"Delete a transaction timeline message","description":"Deletes a transaction timeline message with a specified ID."}},"httpPath":"/transactions/{id}/timeline/{messageId}"},{"label":"Retrieve payout request timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinecollection","routeSlug":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinecollection","metadata":{"seo":{"title":"Retrieve payout request timeline messages","description":"Retrieves a list of payout request timeline messages."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline"},{"label":"Create a payout request timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/postpayoutrequesttimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/postpayoutrequesttimeline","metadata":{"seo":{"title":"Create a payout request timeline comment","description":"Creates a payout request timeline comment."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline"},{"label":"Retrieve a payout request timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinemessage","routeSlug":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinemessage","metadata":{"seo":{"title":"Retrieve a payout request timeline message","description":"Retrieves a payout request timeline message with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline/{messageId}"},{"label":"Delete a payout request timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/deletepayoutrequesttimelinemessage","routeSlug":"/docs/dev-docs/api/transactions-timeline/deletepayoutrequesttimelinemessage","metadata":{"seo":{"title":"Delete a payout request timeline message","description":"Deletes a payout request timeline message with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline/{messageId}"}]},{"type":"separator","label":"Orders & Invoices"},{"type":"group","label":"Orders","link":"/docs/dev-docs/api/orders","routeSlug":"/docs/dev-docs/api/orders","items":[{"label":"Retrieve orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptioncollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptioncollection","metadata":{"seo":{"title":"Retrieve orders","description":"Retrieves a list of orders."}},"httpPath":"/subscriptions"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscription","routeSlug":"/docs/dev-docs/api/orders/postsubscription","metadata":{"seo":{"title":"Create an order","description":"Creates an order."}},"httpPath":"/subscriptions"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscription","routeSlug":"/docs/dev-docs/api/orders/getsubscription","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieves an order with a specified ID."}},"httpPath":"/subscriptions/{id}"},{"label":"Upsert an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/putsubscription","routeSlug":"/docs/dev-docs/api/orders/putsubscription","metadata":{"seo":{"title":"Upsert an order","description":"Creates or updates (upserts) an order with a specified ID."}},"httpPath":"/subscriptions/{id}"},{"label":"Delete a pending order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/deletesubscription","routeSlug":"/docs/dev-docs/api/orders/deletesubscription","metadata":{"seo":{"title":"Delete a pending order","description":"Deletes a pending order with a specified ID."}},"httpPath":"/subscriptions/{id}"},{"label":"Void a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionvoid","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionvoid","metadata":{"seo":{"title":"Void a subscription order","description":"Voids a pending order with a specified ID."}},"httpPath":"/subscriptions/{id}/void"},{"label":"Change subscription order items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionitemschange","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionitemschange","metadata":{"seo":{"title":"Change subscription order items","description":"Changes subscription order items or quantities, and designates if or when pro-rata credits should be given."}},"httpPath":"/subscriptions/{id}/change-items"},{"label":"Update a subscription order item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/patchsubscriptionitem","routeSlug":"/docs/dev-docs/api/orders/patchsubscriptionitem","metadata":{"seo":{"title":"Update a subscription order item","description":"Updates a subscription order item. This is an experimental endpoint and may be changed or removed in the future."}},"badges":[{"name":"Experimental"}],"httpPath":"/subscriptions/{id}/items/{itemId}"},{"label":"Issue an interim invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptioninteriminvoice","routeSlug":"/docs/dev-docs/api/orders/postsubscriptioninteriminvoice","metadata":{"seo":{"title":"Issue an interim invoice","description":"Issues an interim invoice for a subscription order.Use this operation for plan changes and pro rata adjustments."}},"httpPath":"/subscriptions/{id}/interim-invoice"},{"label":"Retrieve subscription order pauses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionpausecollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionpausecollection","metadata":{"seo":{"title":"Retrieve subscription order pauses","description":"Retrieves a list of subscription order pauses."}},"httpPath":"/subscription-pauses"},{"label":"Pause a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionpause","metadata":{"seo":{"title":"Pause a subscription order","description":"Pauses a subscription order with a specified ID."}},"httpPath":"/subscription-pauses"},{"label":"Retrieve a subscription order pause","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionpause","metadata":{"seo":{"title":"Retrieve a subscription order pause","description":"Retrieves a subscription order pause with a specified ID."}},"httpPath":"/subscription-pauses/{id}"},{"label":"Update a subscription order pause","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/putsubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/putsubscriptionpause","metadata":{"seo":{"title":"Update a subscription order pause","description":"Updates a subscription order pause."}},"httpPath":"/subscription-pauses/{id}"},{"label":"Delete a subscription order pause","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/deletesubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/deletesubscriptionpause","metadata":{"seo":{"title":"Delete a subscription order pause","description":"Deletes a subscription order pause with a specified ID.If the specified pause is pending, it is revoked.If the specified pause is ongoing, it is finished."}},"httpPath":"/subscription-pauses/{id}"},{"label":"Retrieve subscription order cancellations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptioncancellationcollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptioncancellationcollection","metadata":{"seo":{"title":"Retrieve subscription order cancellations","description":"Retrieves a list of subscription order cancellations."}},"httpPath":"/subscription-cancellations"},{"label":"Cancel a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/postsubscriptioncancellation","metadata":{"seo":{"title":"Cancel a subscription order","description":"Cancels a subscription order."}},"httpPath":"/subscription-cancellations"},{"label":"Retrieve a subscription order cancellation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/getsubscriptioncancellation","metadata":{"seo":{"title":"Retrieve a subscription order cancellation","description":"Retrieves a subscription order cancellation with a specified ID."}},"httpPath":"/subscription-cancellations/{id}"},{"label":"Upsert a subscription order cancellation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/putsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/putsubscriptioncancellation","metadata":{"seo":{"title":"Upsert a subscription order cancellation","description":"Creates or updates (upserts) a subscription order cancellation with a specified ID."}},"httpPath":"/subscription-cancellations/{id}"},{"label":"Update a subscription order cancellation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/patchsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/patchsubscriptioncancellation","metadata":{"seo":{"title":"Update a subscription order cancellation","description":"Updates a subscription order cancellation with a specified ID. Use this operation to update a cancellation reason and description."}},"httpPath":"/subscription-cancellations/{id}"},{"label":"Delete a subscription order cancellation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/deletesubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/deletesubscriptioncancellation","metadata":{"seo":{"title":"Delete a subscription order cancellation","description":"Deletes a subscription order cancellation with a specified ID."}},"httpPath":"/subscription-cancellations/{id}"},{"label":"Retrieve subscription order reactivations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionreactivationcollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionreactivationcollection","metadata":{"seo":{"title":"Retrieve subscription order reactivations","description":"Retrieves a list of subscription order reactivations."}},"httpPath":"/subscription-reactivations"},{"label":"Reactivate a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionreactivation","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionreactivation","metadata":{"seo":{"title":"Reactivate a subscription order","description":"Reactivates a subscription order with a specified ID."}},"httpPath":"/subscription-reactivations"},{"label":"Retrieve a subscription order reactivation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionreactivation","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionreactivation","metadata":{"seo":{"title":"Retrieve a subscription order reactivation","description":"Retrieves a subscription order reactivation with a specified ID."}},"httpPath":"/subscription-reactivations/{id}"},{"label":"Retrieve an upcoming subscription order invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoice","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoice","metadata":{"seo":{"title":"Retrieve an upcoming subscription order invoice","description":"Retrieves an upcoming invoice for a specified subscription order."}},"httpPath":"/subscriptions/{id}/upcoming-invoice"},{"label":"Issue an upcoming invoice for early pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionupcominginvoiceissuance","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionupcominginvoiceissuance","metadata":{"seo":{"title":"Issue an upcoming invoice for early pay","description":"Issues an upcoming invoice, for a subscription order with a specified ID, for early pay."}},"httpPath":"/subscriptions/{id}/upcoming-invoice/issue"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postprevieworder","routeSlug":"/docs/dev-docs/api/orders/postprevieworder","metadata":{"seo":{"title":"Preview an order","description":"Previews an order. Use this operation to preview a draft order before making an order."}},"httpPath":"/previews/orders"},{"label":"Retrieve upcoming subscription order invoice","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoicecollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoicecollection","metadata":{"seo":{"title":"Retrieve upcoming subscription order invoice","description":"Retrieves an upcoming invoice for a specified subscription order."}},"httpPath":"/subscriptions/{id}/upcoming-invoices"},{"label":"Issue a specific upcoming invoice for early pay","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postupcominginvoiceissuance","routeSlug":"/docs/dev-docs/api/orders/postupcominginvoiceissuance","metadata":{"seo":{"title":"Issue a specific upcoming invoice for early pay","description":"Issues an upcoming invoice with a specified ID for early pay."}},"httpPath":"/subscriptions/{id}/upcoming-invoices/{invoiceId}/issue"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Hard usage limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/hard-usage-limit-reached","routeSlug":"/docs/dev-docs/api/orders/hard-usage-limit-reached","metadata":{"seo":{"title":"Hard usage limit reached","description":"Hard usage limit reached"}},"httpPath":"hard-usage-limit-reached"},{"label":"Order abandoned reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-abandon-reminder","routeSlug":"/docs/dev-docs/api/orders/order-abandon-reminder","metadata":{"seo":{"title":"Order abandoned reminder","description":"Order abandoned reminder"}},"httpPath":"order-abandon-reminder"},{"label":"Order abandoned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-abandoned","routeSlug":"/docs/dev-docs/api/orders/order-abandoned","metadata":{"seo":{"title":"Order abandoned","description":"Order abandoned"}},"httpPath":"order-abandoned"},{"label":"Order completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-completed","routeSlug":"/docs/dev-docs/api/orders/order-completed","metadata":{"seo":{"title":"Order completed","description":"Order completed"}},"httpPath":"order-completed"},{"label":"Renewal invoice issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/renewal-invoice-issued","routeSlug":"/docs/dev-docs/api/orders/renewal-invoice-issued","metadata":{"seo":{"title":"Renewal invoice issued","description":"Renewal invoice issued"}},"httpPath":"renewal-invoice-issued"},{"label":"Soft usage limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/soft-usage-limit-reached","routeSlug":"/docs/dev-docs/api/orders/soft-usage-limit-reached","metadata":{"seo":{"title":"Soft usage limit reached","description":"Soft usage limit reached"}},"httpPath":"soft-usage-limit-reached"},{"label":"Subscription order activated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-activated","routeSlug":"/docs/dev-docs/api/orders/subscription-activated","metadata":{"seo":{"title":"Subscription order activated","description":"Subscription order activated"}},"httpPath":"subscription-activated"},{"label":"Subscription order canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-canceled","routeSlug":"/docs/dev-docs/api/orders/subscription-canceled","metadata":{"seo":{"title":"Subscription order canceled","description":"Subscription order canceled"}},"httpPath":"subscription-canceled"},{"label":"Subscription order churned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-churned","routeSlug":"/docs/dev-docs/api/orders/subscription-churned","metadata":{"seo":{"title":"Subscription order churned","description":"Subscription order churned"}},"httpPath":"subscription-churned"},{"label":"Subscription order created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-created","routeSlug":"/docs/dev-docs/api/orders/subscription-created","metadata":{"seo":{"title":"Subscription order created","description":"Subscription order created"}},"httpPath":"subscription-created"},{"label":"Subscription order downgraded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-downgraded","routeSlug":"/docs/dev-docs/api/orders/subscription-downgraded","metadata":{"seo":{"title":"Subscription order downgraded","description":"Subscription order downgraded"}},"httpPath":"subscription-downgraded"},{"label":"Subscription items changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-items-changed","routeSlug":"/docs/dev-docs/api/orders/subscription-items-changed","metadata":{"seo":{"title":"Subscription items changed","description":"Subscription items changed"}},"httpPath":"subscription-items-changed"},{"label":"Order modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-modified","routeSlug":"/docs/dev-docs/api/orders/subscription-modified","metadata":{"seo":{"title":"Order modified","description":"Order modified"}},"httpPath":"subscription-modified"},{"label":"Subscription quantity filled limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-quantity-filled-limit-reached","routeSlug":"/docs/dev-docs/api/orders/subscription-quantity-filled-limit-reached","metadata":{"seo":{"title":"Subscription quantity filled limit reached","description":"Subscription quantity filled limit reached"}},"httpPath":"subscription-quantity-filled-limit-reached"},{"label":"Subscription order reactivated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-reactivated","routeSlug":"/docs/dev-docs/api/orders/subscription-reactivated","metadata":{"seo":{"title":"Subscription order reactivated","description":"Subscription order reactivated"}},"httpPath":"subscription-reactivated"},{"label":"Subscription renewal reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-renewal-reminder","routeSlug":"/docs/dev-docs/api/orders/subscription-renewal-reminder","metadata":{"seo":{"title":"Subscription renewal reminder","description":"Subscription renewal reminder"}},"httpPath":"subscription-renewal-reminder"},{"label":"Subscription order renewed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-renewed","routeSlug":"/docs/dev-docs/api/orders/subscription-renewed","metadata":{"seo":{"title":"Subscription order renewed","description":"Subscription order renewed"}},"httpPath":"subscription-renewed"},{"label":"Subscription order trial converted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-trial-converted","routeSlug":"/docs/dev-docs/api/orders/subscription-trial-converted","metadata":{"seo":{"title":"Subscription order trial converted","description":"Subscription order trial converted"}},"httpPath":"subscription-trial-converted"},{"label":"Subscription order trial end reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-trial-end-reminder","routeSlug":"/docs/dev-docs/api/orders/subscription-trial-end-reminder","metadata":{"seo":{"title":"Subscription order trial end reminder","description":"Subscription order trial end reminder"}},"httpPath":"subscription-trial-end-reminder"},{"label":"Subscription order trial ended","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-trial-ended","routeSlug":"/docs/dev-docs/api/orders/subscription-trial-ended","metadata":{"seo":{"title":"Subscription order trial ended","description":"Subscription order trial ended"}},"httpPath":"subscription-trial-ended"},{"label":"Subscription order upgraded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-upgraded","routeSlug":"/docs/dev-docs/api/orders/subscription-upgraded","metadata":{"seo":{"title":"Subscription order upgraded","description":"Subscription order upgraded"}},"httpPath":"subscription-upgraded"},{"label":"Subscription order paused","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-paused","routeSlug":"/docs/dev-docs/api/orders/subscription-paused","metadata":{"seo":{"title":"Subscription order paused","description":"Subscription order paused"}},"httpPath":"subscription-paused"},{"label":"Subscription order pause created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-pause-created","routeSlug":"/docs/dev-docs/api/orders/subscription-pause-created","metadata":{"seo":{"title":"Subscription order pause created","description":"Subscription order pause created"}},"httpPath":"subscription-pause-created"},{"label":"Subscription order pause modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-pause-modified","routeSlug":"/docs/dev-docs/api/orders/subscription-pause-modified","metadata":{"seo":{"title":"Subscription order pause modified","description":"Subscription order pause modified"}},"httpPath":"subscription-pause-modified"},{"label":"Subscription order pause revoked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-pause-revoked","routeSlug":"/docs/dev-docs/api/orders/subscription-pause-revoked","metadata":{"seo":{"title":"Subscription order pause revoked","description":"Subscription order pause revoked"}},"httpPath":"subscription-pause-revoked"},{"label":"Subscription order resumed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-resumed","routeSlug":"/docs/dev-docs/api/orders/subscription-resumed","metadata":{"seo":{"title":"Subscription order resumed","description":"Subscription order resumed"}},"httpPath":"subscription-resumed"},{"label":"Trial usage limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/trial-usage-limit-reached","routeSlug":"/docs/dev-docs/api/orders/trial-usage-limit-reached","metadata":{"seo":{"title":"Trial usage limit reached","description":"Trial usage limit reached"}},"httpPath":"trial-usage-limit-reached"},{"label":"Order delinquency time reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-delinquency-reached","routeSlug":"/docs/dev-docs/api/orders/order-delinquency-reached","metadata":{"seo":{"title":"Order delinquency time reached","description":"Order delinquency time reached"}},"httpPath":"order-delinquency-reached"}]},{"type":"group","label":"Invoices","link":"/docs/dev-docs/api/invoices","routeSlug":"/docs/dev-docs/api/invoices","items":[{"label":"Retrieve invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoicecollection","routeSlug":"/docs/dev-docs/api/invoices/getinvoicecollection","metadata":{"seo":{"title":"Retrieve invoices","description":"Retrieves a list of invoices."}},"httpPath":"/invoices"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoice","routeSlug":"/docs/dev-docs/api/invoices/postinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Creates an invoice."}},"httpPath":"/invoices"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoice","routeSlug":"/docs/dev-docs/api/invoices/getinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves an invoice with a specified ID."}},"httpPath":"/invoices/{id}"},{"label":"Upsert an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/putinvoice","routeSlug":"/docs/dev-docs/api/invoices/putinvoice","metadata":{"seo":{"title":"Upsert an invoice","description":"Creates or updates (upserts) an invoice with a specified ID. Returns a conflict error if the specified ID belongs to an upcoming invoice."}},"httpPath":"/invoices/{id}"},{"label":"Retrieve invoice items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoiceitemcollection","routeSlug":"/docs/dev-docs/api/invoices/getinvoiceitemcollection","metadata":{"seo":{"title":"Retrieve invoice items","description":"Retrieves invoice items with a specified invoice ID."}},"httpPath":"/invoices/{id}/items"},{"label":"Create an invoice item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceitem","metadata":{"seo":{"title":"Create an invoice item","description":"Creates an invoice item."}},"httpPath":"/invoices/{id}/items"},{"label":"Retrieve an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/getinvoiceitem","metadata":{"seo":{"title":"Retrieve an invoice item","description":"Retrieves an invoice item."}},"httpPath":"/invoices/{id}/items/{itemId}"},{"label":"Update an invoice item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/putinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/putinvoiceitem","metadata":{"seo":{"title":"Update an invoice item","description":"Updates an invoice item."}},"httpPath":"/invoices/{id}/items/{itemId}"},{"label":"Delete an invoice item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/deleteinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/deleteinvoiceitem","metadata":{"seo":{"title":"Delete an invoice item","description":"Deletes an invoice item."}},"httpPath":"/invoices/{id}/items/{itemId}"},{"label":"Issue an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceissuance","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceissuance","metadata":{"seo":{"title":"Issue an invoice","description":"Issues an invoice with a specified ID.The invoice must be in draft status."}},"httpPath":"/invoices/{id}/issue"},{"label":"Abandon an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceabandonment","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceabandonment","metadata":{"seo":{"title":"Abandon an invoice","description":"Abandons an invoice with a specified ID."}},"httpPath":"/invoices/{id}/abandon"},{"label":"Void an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicevoid","routeSlug":"/docs/dev-docs/api/invoices/postinvoicevoid","metadata":{"seo":{"title":"Void an invoice","description":"Voids an invoice with a specified ID."}},"httpPath":"/invoices/{id}/void"},{"label":"Recalculate an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicerecalculation","routeSlug":"/docs/dev-docs/api/invoices/postinvoicerecalculation","metadata":{"seo":{"title":"Recalculate an invoice","description":"Recalculates shipping rates, taxes, and discounts on an invoice with a specified ID."}},"httpPath":"/invoices/{id}/recalculate"},{"label":"Reissue an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicereissuance","routeSlug":"/docs/dev-docs/api/invoices/postinvoicereissuance","metadata":{"seo":{"title":"Reissue an invoice","description":"Reissues an invoice with a specified ID.The status of the invoice must be unpaid, partially paid, past due or abandoned."}},"httpPath":"/invoices/{id}/reissue"},{"label":"Retrieve transaction amounts allocations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoicetransactionallocationcollection","routeSlug":"/docs/dev-docs/api/invoices/getinvoicetransactionallocationcollection","metadata":{"seo":{"title":"Retrieve transaction amounts allocations","description":"Retrieves amounts from a transaction that are allocated as invoice payments."}},"httpPath":"/invoices/{id}/transaction-allocations"},{"label":"Allocate customer credit balance to an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceallocatecreditbalance","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceallocatecreditbalance","metadata":{"seo":{"title":"Allocate customer credit balance to an invoice","description":"Allocates existing allocatable credit memos related to the invoice customer.Specific credit memos cannot be provided in the request and are selected automatically.Allocation can be capped with amount.Credit memos are applied automatically in the specified allocation order.If no order is specified, oldest-first is used."}},"httpPath":"/invoices/{id}/allocate-credit-balance"},{"label":"Apply a transaction to an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicetransaction","routeSlug":"/docs/dev-docs/api/invoices/postinvoicetransaction","metadata":{"seo":{"title":"Apply a transaction to an invoice","description":"Applies a transaction to an invoice.The invoice status must be unpaid, and the transaction must have a non-zero unused amount."}},"httpPath":"/invoices/{id}/transaction"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Invoice tax calculation failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-tax-calculation-failed","routeSlug":"/docs/dev-docs/api/invoices/invoice-tax-calculation-failed","metadata":{"seo":{"title":"Invoice tax calculation failed","description":"Invoice tax calculation failed"}},"httpPath":"invoice-tax-calculation-failed"},{"label":"Invoice abandoned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-abandoned","routeSlug":"/docs/dev-docs/api/invoices/invoice-abandoned","metadata":{"seo":{"title":"Invoice abandoned","description":"Invoice abandoned"}},"httpPath":"invoice-abandoned"},{"label":"Invoice created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-created","routeSlug":"/docs/dev-docs/api/invoices/invoice-created","metadata":{"seo":{"title":"Invoice created","description":"Invoice created"}},"httpPath":"invoice-created"},{"label":"Invoice issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-issued","routeSlug":"/docs/dev-docs/api/invoices/invoice-issued","metadata":{"seo":{"title":"Invoice issued","description":"Invoice issued"}},"httpPath":"invoice-issued"},{"label":"Invoice modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-modified","routeSlug":"/docs/dev-docs/api/invoices/invoice-modified","metadata":{"seo":{"title":"Invoice modified","description":"Invoice modified"}},"httpPath":"invoice-modified"},{"label":"Invoice paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-paid","routeSlug":"/docs/dev-docs/api/invoices/invoice-paid","metadata":{"seo":{"title":"Invoice paid","description":"Invoice paid"}},"httpPath":"invoice-paid"},{"label":"Invoice partially paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-partially-paid","routeSlug":"/docs/dev-docs/api/invoices/invoice-partially-paid","metadata":{"seo":{"title":"Invoice partially paid","description":"Invoice partially paid"}},"httpPath":"invoice-partially-paid"},{"label":"Invoice refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-refunded","routeSlug":"/docs/dev-docs/api/invoices/invoice-refunded","metadata":{"seo":{"title":"Invoice refunded","description":"Invoice refunded"}},"httpPath":"invoice-refunded"},{"label":"Invoice partially refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-partially-refunded","routeSlug":"/docs/dev-docs/api/invoices/invoice-partially-refunded","metadata":{"seo":{"title":"Invoice partially refunded","description":"Invoice partially refunded"}},"httpPath":"invoice-partially-refunded"},{"label":"Invoice past due","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-past-due","routeSlug":"/docs/dev-docs/api/invoices/invoice-past-due","metadata":{"seo":{"title":"Invoice past due","description":"Invoice past due"}},"httpPath":"invoice-past-due"},{"label":"Invoice past due reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-past-due-reminder","routeSlug":"/docs/dev-docs/api/invoices/invoice-past-due-reminder","metadata":{"seo":{"title":"Invoice past due reminder","description":"Invoice past due reminder"}},"httpPath":"invoice-past-due-reminder"},{"label":"Invoice reissued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-reissued","routeSlug":"/docs/dev-docs/api/invoices/invoice-reissued","metadata":{"seo":{"title":"Invoice reissued","description":"Invoice reissued"}},"httpPath":"invoice-reissued"},{"label":"Invoice voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-voided","routeSlug":"/docs/dev-docs/api/invoices/invoice-voided","metadata":{"seo":{"title":"Invoice voided","description":"Invoice voided"}},"httpPath":"invoice-voided"},{"label":"Renewal invoice payment canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/renewal-invoice-payment-canceled","routeSlug":"/docs/dev-docs/api/invoices/renewal-invoice-payment-canceled","metadata":{"seo":{"title":"Renewal invoice payment canceled","description":"Renewal invoice payment canceled"}},"httpPath":"renewal-invoice-payment-canceled"},{"label":"Renewal invoice payment declined","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/renewal-invoice-payment-declined","routeSlug":"/docs/dev-docs/api/invoices/renewal-invoice-payment-declined","metadata":{"seo":{"title":"Renewal invoice payment declined","description":"Renewal invoice payment declined"}},"httpPath":"renewal-invoice-payment-declined"}]},{"type":"group","label":"Usage","link":"/docs/dev-docs/api/usage","routeSlug":"/docs/dev-docs/api/usage","items":[{"label":"Retrieve usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/getusagecollection","routeSlug":"/docs/dev-docs/api/usage/getusagecollection","metadata":{"seo":{"title":"Retrieve usage records","description":"Retrieves a list of usage records."}},"httpPath":"/usages"},{"label":"Create a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/postusage","routeSlug":"/docs/dev-docs/api/usage/postusage","metadata":{"seo":{"title":"Create a usage record","description":"Creates a usage report."}},"httpPath":"/usages"},{"label":"Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/getusage","routeSlug":"/docs/dev-docs/api/usage/getusage","metadata":{"seo":{"title":"Retrieve a usage record","description":"Retrieves a usage record with a specified ID."}},"httpPath":"/usages/{id}"},{"label":"Delete a usage record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/deleteusage","routeSlug":"/docs/dev-docs/api/usage/deleteusage","metadata":{"seo":{"title":"Delete a usage record","description":"Deletes a usage record with a specified ID."}},"httpPath":"/usages/{id}"}]},{"type":"group","label":"Credit memos","link":"/docs/dev-docs/api/credit-memos","routeSlug":"/docs/dev-docs/api/credit-memos","items":[{"label":"Retrieve credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/getcreditmemocollection","routeSlug":"/docs/dev-docs/api/credit-memos/getcreditmemocollection","metadata":{"seo":{"title":"Retrieve credit memos","description":"Retrieves a list of credit memos."}},"httpPath":"/credit-memos"},{"label":"Create a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/postcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/postcreditmemo","metadata":{"seo":{"title":"Create a credit memo","description":"Creates a credit memo."}},"httpPath":"/credit-memos"},{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/getcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/getcreditmemo","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Retrieves a credit memo with a specified ID."}},"httpPath":"/credit-memos/{id}"},{"label":"Upsert a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/putcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/putcreditmemo","metadata":{"seo":{"title":"Upsert a credit memo","description":"Creates or updates (upserts) a credit memo with a specified ID."}},"httpPath":"/credit-memos/{id}"},{"label":"Partially update a credit memo","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/patchcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/patchcreditmemo","metadata":{"seo":{"title":"Partially update a credit memo","description":"Partially updates a credit memo with a specified ID."}},"httpPath":"/credit-memos/{id}"},{"label":"Void a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/postcreditmemovoid","routeSlug":"/docs/dev-docs/api/credit-memos/postcreditmemovoid","metadata":{"seo":{"title":"Void a credit memo","description":"Voids a credit memo with a specified ID."}},"httpPath":"/credit-memos/{id}/void"},{"label":"Refund a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/postcreditmemorefund","routeSlug":"/docs/dev-docs/api/credit-memos/postcreditmemorefund","metadata":{"seo":{"title":"Refund a credit memo","description":"Refunds a credit memo with a specified ID. The transactions of the last invoice for the order or the invoice directly related to the credit memo are refunded."}},"httpPath":"/credit-memos/{id}/refund"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Credit memo applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-applied","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-applied","metadata":{"seo":{"title":"Credit memo applied","description":"Credit memo applied"}},"httpPath":"credit-memo-applied"},{"label":"Credit memo created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-created","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-created","metadata":{"seo":{"title":"Credit memo created","description":"Credit memo created"}},"httpPath":"credit-memo-created"},{"label":"Credit memo modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-modified","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-modified","metadata":{"seo":{"title":"Credit memo modified","description":"Credit memo modified"}},"httpPath":"credit-memo-modified"},{"label":"Credit memo partially applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-partially-applied","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-partially-applied","metadata":{"seo":{"title":"Credit memo partially applied","description":"Credit memo partially applied"}},"httpPath":"credit-memo-partially-applied"},{"label":"Credit memo voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-voided","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-voided","metadata":{"seo":{"title":"Credit memo voided","description":"Credit memo voided"}},"httpPath":"credit-memo-voided"}]},{"type":"group","label":"Plans","link":"/docs/dev-docs/api/plans","routeSlug":"/docs/dev-docs/api/plans","items":[{"label":"Retrieve plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/getplancollection","routeSlug":"/docs/dev-docs/api/plans/getplancollection","metadata":{"seo":{"title":"Retrieve plans","description":"Retrieves a list of plans."}},"httpPath":"/plans"},{"label":"Create a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/postplan","routeSlug":"/docs/dev-docs/api/plans/postplan","metadata":{"seo":{"title":"Create a plan","description":"Creates a plan."}},"httpPath":"/plans"},{"label":"Retrieve a plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/getplan","routeSlug":"/docs/dev-docs/api/plans/getplan","metadata":{"seo":{"title":"Retrieve a plan","description":"Retrieves a plan with a specified ID."}},"httpPath":"/plans/{id}"},{"label":"Upsert a plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/putplan","routeSlug":"/docs/dev-docs/api/plans/putplan","metadata":{"seo":{"title":"Upsert a plan","description":"Creates or updates (upserts) a plan with a specified ID."}},"httpPath":"/plans/{id}"},{"label":"Delete a plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/deleteplan","routeSlug":"/docs/dev-docs/api/plans/deleteplan","metadata":{"seo":{"title":"Delete a plan","description":"Deletes a plan with a specified ID."}},"httpPath":"/plans/{id}"}]},{"type":"group","label":"Products","link":"/docs/dev-docs/api/products","routeSlug":"/docs/dev-docs/api/products","items":[{"label":"Retrieve products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/getproductcollection","routeSlug":"/docs/dev-docs/api/products/getproductcollection","metadata":{"seo":{"title":"Retrieve products","description":"Retrieves a list of products."}},"httpPath":"/products"},{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/postproduct","routeSlug":"/docs/dev-docs/api/products/postproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a product."}},"httpPath":"/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/getproduct","routeSlug":"/docs/dev-docs/api/products/getproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves a product with a specified ID."}},"httpPath":"/products/{id}"},{"label":"Upsert a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/putproduct","routeSlug":"/docs/dev-docs/api/products/putproduct","metadata":{"seo":{"title":"Upsert a product","description":"Creates or updates (upserts) a product with a specified ID."}},"httpPath":"/products/{id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/deleteproduct","routeSlug":"/docs/dev-docs/api/products/deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Deletes a product with a specified ID."}},"httpPath":"/products/{id}"}]},{"type":"group","label":"Coupons","link":"/docs/dev-docs/api/coupons","routeSlug":"/docs/dev-docs/api/coupons","items":[{"type":"link","label":"Coupon restriction types","link":"/docs/dev-docs/api/coupons/coupon-restriction-types","routeSlug":"/docs/dev-docs/api/coupons/coupon-restriction-types"},{"label":"Retrieve coupon redemptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcouponredemptioncollection","routeSlug":"/docs/dev-docs/api/coupons/getcouponredemptioncollection","metadata":{"seo":{"title":"Retrieve coupon redemptions","description":"Retrieves a list of coupon redemptions."}},"httpPath":"/coupons-redemptions"},{"label":"Redeem a coupon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcouponredemption","routeSlug":"/docs/dev-docs/api/coupons/postcouponredemption","metadata":{"seo":{"title":"Redeem a coupon","description":"Redeems a coupon."}},"httpPath":"/coupons-redemptions"},{"label":"Retrieve a coupon redemption","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcouponredemption","routeSlug":"/docs/dev-docs/api/coupons/getcouponredemption","metadata":{"seo":{"title":"Retrieve a coupon redemption","description":"Retrieves a coupon redemption with a specified ID."}},"httpPath":"/coupons-redemptions/{id}"},{"label":"Cancel a coupon redemption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcouponredemptioncancellation","routeSlug":"/docs/dev-docs/api/coupons/postcouponredemptioncancellation","metadata":{"seo":{"title":"Cancel a coupon redemption","description":"Cancels a coupon redemption with a specified ID."}},"httpPath":"/coupons-redemptions/{id}/cancel"},{"label":"Retrieve coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcouponcollection","routeSlug":"/docs/dev-docs/api/coupons/getcouponcollection","metadata":{"seo":{"title":"Retrieve coupons","description":"Retrieves a list of coupons."}},"httpPath":"/coupons"},{"label":"Create a coupon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcoupon","routeSlug":"/docs/dev-docs/api/coupons/postcoupon","metadata":{"seo":{"title":"Create a coupon","description":"Creates a coupon."}},"httpPath":"/coupons"},{"label":"Retrieve a coupon","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcoupon","routeSlug":"/docs/dev-docs/api/coupons/getcoupon","metadata":{"seo":{"title":"Retrieve a coupon","description":"Retrieves a coupon with a specified ID."}},"httpPath":"/coupons/{id}"},{"label":"Upsert a coupon","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/putcoupon","routeSlug":"/docs/dev-docs/api/coupons/putcoupon","metadata":{"seo":{"title":"Upsert a coupon","description":"Creates or updates (upserts) a coupon with a specified coupon ID."}},"httpPath":"/coupons/{id}"},{"label":"Specify a coupon expiration time","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcouponexpiration","routeSlug":"/docs/dev-docs/api/coupons/postcouponexpiration","metadata":{"seo":{"title":"Specify a coupon expiration time","description":"Specifies the expiration time of a coupon with a specified ID.The expiredTime of a coupon must be greater than its issuedTime."}},"httpPath":"/coupons/{id}/expiration"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Coupon application removed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-application-removed","routeSlug":"/docs/dev-docs/api/coupons/coupon-application-removed","metadata":{"seo":{"title":"Coupon application removed","description":"Coupon application removed"}},"httpPath":"coupon-application-removed"},{"label":"Coupon applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-applied","routeSlug":"/docs/dev-docs/api/coupons/coupon-applied","metadata":{"seo":{"title":"Coupon applied","description":"Coupon applied"}},"httpPath":"coupon-applied"},{"label":"Coupon expiration modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-expiration-modified","routeSlug":"/docs/dev-docs/api/coupons/coupon-expiration-modified","metadata":{"seo":{"title":"Coupon expiration modified","description":"Coupon expiration modified"}},"httpPath":"coupon-expiration-modified"},{"label":"Coupon expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-expired","routeSlug":"/docs/dev-docs/api/coupons/coupon-expired","metadata":{"seo":{"title":"Coupon expired","description":"Coupon expired"}},"httpPath":"coupon-expired"},{"label":"Coupon issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-issued","routeSlug":"/docs/dev-docs/api/coupons/coupon-issued","metadata":{"seo":{"title":"Coupon issued","description":"Coupon issued"}},"httpPath":"coupon-issued"},{"label":"Coupon modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-modified","routeSlug":"/docs/dev-docs/api/coupons/coupon-modified","metadata":{"seo":{"title":"Coupon modified","description":"Coupon modified"}},"httpPath":"coupon-modified"},{"label":"Coupon redeemed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-redeemed","routeSlug":"/docs/dev-docs/api/coupons/coupon-redeemed","metadata":{"seo":{"title":"Coupon redeemed","description":"Coupon redeemed"}},"httpPath":"coupon-redeemed"},{"label":"Coupon redemption canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-redemption-canceled","routeSlug":"/docs/dev-docs/api/coupons/coupon-redemption-canceled","metadata":{"seo":{"title":"Coupon redemption canceled","description":"Coupon redemption canceled"}},"httpPath":"coupon-redemption-canceled"}]},{"type":"group","label":"Quotes","link":"/docs/dev-docs/api/quotes","routeSlug":"/docs/dev-docs/api/quotes","items":[{"label":"Retrieve quotes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/getquotecollection","routeSlug":"/docs/dev-docs/api/quotes/getquotecollection","metadata":{"seo":{"title":"Retrieve quotes","description":"Retrieves a list of quotes."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes"},{"label":"Create a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquote","routeSlug":"/docs/dev-docs/api/quotes/postquote","metadata":{"seo":{"title":"Create a quote","description":"Creates a quote."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes"},{"label":"Retrieve a quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/getquote","routeSlug":"/docs/dev-docs/api/quotes/getquote","metadata":{"seo":{"title":"Retrieve a quote","description":"Retrieves a quote with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}"},{"label":"Upsert a quote","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/putquote","routeSlug":"/docs/dev-docs/api/quotes/putquote","metadata":{"seo":{"title":"Upsert a quote","description":"Creates or updates a quote with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}"},{"label":"Partially update a quote","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/patchquote","routeSlug":"/docs/dev-docs/api/quotes/patchquote","metadata":{"seo":{"title":"Partially update a quote","description":"Partially updates a quote with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}"},{"label":"Accept a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoteacceptance","routeSlug":"/docs/dev-docs/api/quotes/postquoteacceptance","metadata":{"seo":{"title":"Accept a quote","description":"Accepts an issued quote with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/accept"},{"label":"Cancel a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquotecancellation","routeSlug":"/docs/dev-docs/api/quotes/postquotecancellation","metadata":{"seo":{"title":"Cancel a quote","description":"Cancels a draft or issued quote with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/cancel"},{"label":"Issue a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoteissuance","routeSlug":"/docs/dev-docs/api/quotes/postquoteissuance","metadata":{"seo":{"title":"Issue a quote","description":"Issues a draft quote with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/issue"},{"label":"Recall a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoterecall","routeSlug":"/docs/dev-docs/api/quotes/postquoterecall","metadata":{"seo":{"title":"Recall a quote","description":"Recalls an issued quote with a specified ID so that it can be edited.Recalled quotes are assigned the status of draft."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/recall"},{"label":"Reject a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoterejection","routeSlug":"/docs/dev-docs/api/quotes/postquoterejection","metadata":{"seo":{"title":"Reject a quote","description":"Rejects an issued quote with specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/reject"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Quote accepted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-accepted","routeSlug":"/docs/dev-docs/api/quotes/quote-accepted","metadata":{"seo":{"title":"Quote accepted","description":"Quote accepted"}},"httpPath":"quote-accepted"},{"label":"Quote canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-canceled","routeSlug":"/docs/dev-docs/api/quotes/quote-canceled","metadata":{"seo":{"title":"Quote canceled","description":"Quote canceled"}},"httpPath":"quote-canceled"},{"label":"Quote created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-created","routeSlug":"/docs/dev-docs/api/quotes/quote-created","metadata":{"seo":{"title":"Quote created","description":"Quote created"}},"httpPath":"quote-created"},{"label":"Quote expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-expired","routeSlug":"/docs/dev-docs/api/quotes/quote-expired","metadata":{"seo":{"title":"Quote expired","description":"Quote expired"}},"httpPath":"quote-expired"},{"label":"Quote issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-issued","routeSlug":"/docs/dev-docs/api/quotes/quote-issued","metadata":{"seo":{"title":"Quote issued","description":"Quote issued"}},"httpPath":"quote-issued"},{"label":"Quote recalled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-recalled","routeSlug":"/docs/dev-docs/api/quotes/quote-recalled","metadata":{"seo":{"title":"Quote recalled","description":"Quote recalled"}},"httpPath":"quote-recalled"},{"label":"Quote rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-rejected","routeSlug":"/docs/dev-docs/api/quotes/quote-rejected","metadata":{"seo":{"title":"Quote rejected","description":"Quote rejected"}},"httpPath":"quote-rejected"},{"label":"Quote updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-updated","routeSlug":"/docs/dev-docs/api/quotes/quote-updated","metadata":{"seo":{"title":"Quote updated","description":"Quote updated"}},"httpPath":"quote-updated"}]},{"type":"group","label":"Quotes timeline","link":"/docs/dev-docs/api/quotes-timeline","routeSlug":"/docs/dev-docs/api/quotes-timeline","items":[{"label":"Retrieve quote timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/getquotetimelinecollection","routeSlug":"/docs/dev-docs/api/quotes-timeline/getquotetimelinecollection","metadata":{"seo":{"title":"Retrieve quote timeline messages","description":"Retrieves quote timeline messages."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline"},{"label":"Create a quote timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/postquotetimeline","routeSlug":"/docs/dev-docs/api/quotes-timeline/postquotetimeline","metadata":{"seo":{"title":"Create a quote timeline comment","description":"Creates a quote timeline comment or custom defined event."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline"},{"label":"Retrieve a quote timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/getquotetimeline","routeSlug":"/docs/dev-docs/api/quotes-timeline/getquotetimeline","metadata":{"seo":{"title":"Retrieve a quote timeline message","description":"Retrieves a quote timeline message with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline/{messageId}"},{"label":"Delete a quote timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/deletequotetimeline","routeSlug":"/docs/dev-docs/api/quotes-timeline/deletequotetimeline","metadata":{"seo":{"title":"Delete a quote timeline message","description":"Deletes a quote timeline message with a specified ID."}},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline/{messageId}"}]},{"type":"group","label":"Shipping rates","link":"/docs/dev-docs/api/shipping-rates","routeSlug":"/docs/dev-docs/api/shipping-rates","items":[{"label":"Retrieve shipping rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/getshippingratecollection","routeSlug":"/docs/dev-docs/api/shipping-rates/getshippingratecollection","metadata":{"seo":{"title":"Retrieve shipping rates","description":"Retrieves a list of shipping rates."}},"httpPath":"/shipping-rates"},{"label":"Create a shipping rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/postshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/postshippingrate","metadata":{"seo":{"title":"Create a shipping rate","description":"Creates a shipping rate."}},"httpPath":"/shipping-rates"},{"label":"Retrieve a shipping rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/getshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/getshippingrate","metadata":{"seo":{"title":"Retrieve a shipping rate","description":"Retrieves a shipping rate with a specified ID."}},"httpPath":"/shipping-rates/{id}"},{"label":"Create a shipping rate with ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/putshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/putshippingrate","metadata":{"seo":{"title":"Create a shipping rate with ID","description":"Creates a shipping rate with a specified ID."}},"httpPath":"/shipping-rates/{id}"},{"label":"Delete a shipping rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/deleteshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/deleteshippingrate","metadata":{"seo":{"title":"Delete a shipping rate","description":"Deletes a shipping rate with a specified ID."}},"httpPath":"/shipping-rates/{id}"}]},{"type":"group","label":"Orders timeline","link":"/docs/dev-docs/api/orders-timeline","routeSlug":"/docs/dev-docs/api/orders-timeline","items":[{"label":"Retrieve order timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimelinecollection","routeSlug":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimelinecollection","metadata":{"seo":{"title":"Retrieve order timeline messages","description":"Retrieves a list of order timeline messages."}},"httpPath":"/subscriptions/{id}/timeline"},{"label":"Create an order timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/postsubscriptiontimeline","routeSlug":"/docs/dev-docs/api/orders-timeline/postsubscriptiontimeline","metadata":{"seo":{"title":"Create an order timeline comment","description":"Creates an order timeline comment."}},"httpPath":"/subscriptions/{id}/timeline"},{"label":"Retrieve an order timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimeline","routeSlug":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimeline","metadata":{"seo":{"title":"Retrieve an order timeline message","description":"Retrieves an order timeline message with a specified ID."}},"httpPath":"/subscriptions/{id}/timeline/{messageId}"},{"label":"Delete an order timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/deletesubscriptiontimeline","routeSlug":"/docs/dev-docs/api/orders-timeline/deletesubscriptiontimeline","metadata":{"seo":{"title":"Delete an order timeline message","description":"Deletes an order timeline message with a specified ID."}},"httpPath":"/subscriptions/{id}/timeline/{messageId}"}]},{"type":"group","label":"Invoices timeline","link":"/docs/dev-docs/api/invoices-timeline","routeSlug":"/docs/dev-docs/api/invoices-timeline","items":[{"label":"Retrieve invoice timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/getinvoicetimelinecollection","routeSlug":"/docs/dev-docs/api/invoices-timeline/getinvoicetimelinecollection","metadata":{"seo":{"title":"Retrieve invoice timeline messages","description":"Retrieves a list of invoice timeline messages."}},"httpPath":"/invoices/{id}/timeline"},{"label":"Create an invoice timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/postinvoicetimeline","routeSlug":"/docs/dev-docs/api/invoices-timeline/postinvoicetimeline","metadata":{"seo":{"title":"Create an invoice timeline comment","description":"Creates an invoice timeline comment."}},"httpPath":"/invoices/{id}/timeline"},{"label":"Retrieve an invoice timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/getinvoicetimeline","routeSlug":"/docs/dev-docs/api/invoices-timeline/getinvoicetimeline","metadata":{"seo":{"title":"Retrieve an invoice timeline message","description":"Retrieves an invoice timeline message with a specified ID."}},"httpPath":"/invoices/{id}/timeline/{messageId}"},{"label":"Delete an invoice timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/deleteinvoicetimeline","routeSlug":"/docs/dev-docs/api/invoices-timeline/deleteinvoicetimeline","metadata":{"seo":{"title":"Delete an invoice timeline message","description":"Deletes an invoice timeline message with a specified ID."}},"httpPath":"/invoices/{id}/timeline/{messageId}"}]},{"type":"group","label":"Credit memos timeline","link":"/docs/dev-docs/api/credit-memos-timeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline","items":[{"label":"Retrieve credit memo timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimelinecollection","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimelinecollection","metadata":{"seo":{"title":"Retrieve credit memo timeline messages","description":"Retrieves a list of credit memo timeline messages."}},"httpPath":"/credit-memos/{id}/timeline"},{"label":"Create a credit memo timeline message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/postcreditmemotimeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/postcreditmemotimeline","metadata":{"seo":{"title":"Create a credit memo timeline message","description":"Creates a credit memo timeline message."}},"httpPath":"/credit-memos/{id}/timeline"},{"label":"Retrieve a credit memo timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimeline","metadata":{"seo":{"title":"Retrieve a credit memo timeline message","description":"Retrieves a credit memo timeline message with a specified ID."}},"httpPath":"/credit-memos/{id}/timeline/{messageId}"},{"label":"Delete a credit memo timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/deletecreditmemotimeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/deletecreditmemotimeline","metadata":{"seo":{"title":"Delete a credit memo timeline message","description":"Deletes a credit memo timeline message with a specified ID."}},"httpPath":"/credit-memos/{id}/timeline/{messageId}"}]},{"type":"separator","label":"Risk"},{"type":"group","label":"Blocklists","link":"/docs/dev-docs/api/blocklists","routeSlug":"/docs/dev-docs/api/blocklists","items":[{"label":"Retrieve blocklists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/getblocklistcollection","routeSlug":"/docs/dev-docs/api/blocklists/getblocklistcollection","metadata":{"seo":{"title":"Retrieve blocklists","description":"Retrieves a list of all blocklists."}},"httpPath":"/blocklists"},{"label":"Create a blocklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/postblocklist","routeSlug":"/docs/dev-docs/api/blocklists/postblocklist","metadata":{"seo":{"title":"Create a blocklist","description":"Creates a blocklist."}},"httpPath":"/blocklists"},{"label":"Retrieve a blocklist","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/getblocklist","routeSlug":"/docs/dev-docs/api/blocklists/getblocklist","metadata":{"seo":{"title":"Retrieve a blocklist","description":"Retrieves a blocklist with a specified ID."}},"httpPath":"/blocklists/{id}"},{"label":"Create a blocklist with specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/putblocklist","routeSlug":"/docs/dev-docs/api/blocklists/putblocklist","metadata":{"seo":{"title":"Create a blocklist with specified ID","description":"Creates a blocklist with a specified ID."}},"httpPath":"/blocklists/{id}"},{"label":"Delete a blocklist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/deleteblocklist","routeSlug":"/docs/dev-docs/api/blocklists/deleteblocklist","metadata":{"seo":{"title":"Delete a blocklist","description":"Deletes a blocklist with a specified ID."}},"httpPath":"/blocklists/{id}"}]},{"type":"group","label":"Allowlists","link":"/docs/dev-docs/api/allowlists","routeSlug":"/docs/dev-docs/api/allowlists","items":[{"label":"Retrieve allowlist collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/getallowlistcollection","routeSlug":"/docs/dev-docs/api/allowlists/getallowlistcollection","metadata":{"seo":{"title":"Retrieve allowlist collection","description":"Retrieves allowlist collection."}},"httpPath":"/allowlists"},{"label":"Create allowlist record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/postallowlist","routeSlug":"/docs/dev-docs/api/allowlists/postallowlist","metadata":{"seo":{"title":"Create allowlist record","description":"Creates allowlist record."}},"httpPath":"/allowlists"},{"label":"Retrieve allowlist record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/getallowlist","routeSlug":"/docs/dev-docs/api/allowlists/getallowlist","metadata":{"seo":{"title":"Retrieve allowlist record","description":"Retrieves allowlist record."}},"httpPath":"/allowlists/{id}"},{"label":"Delete allowlist record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/deleteallowlist","routeSlug":"/docs/dev-docs/api/allowlists/deleteallowlist","metadata":{"seo":{"title":"Delete allowlist record","description":"Deletes allowlist record with a specified ID."}},"httpPath":"/allowlists/{id}"}]},{"type":"group","label":"KYC documents","link":"/docs/dev-docs/api/kyc-documents","routeSlug":"/docs/dev-docs/api/kyc-documents","items":[{"type":"link","label":"Credit file proof","link":"/docs/dev-docs/api/kyc-documents/credit-file-proof","routeSlug":"/docs/dev-docs/api/kyc-documents/credit-file-proof"},{"label":"Create a KYC request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycrequest","metadata":{"seo":{"title":"Create a KYC request","description":"Creates a KYC request."}},"httpPath":"/kyc-requests"},{"label":"Retrieve KYC requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycrequestcollection","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycrequestcollection","metadata":{"seo":{"title":"Retrieve KYC requests","description":"Retrieves a list of KYC requests."}},"httpPath":"/kyc-requests"},{"label":"Retrieve a KYC request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycrequest","metadata":{"seo":{"title":"Retrieve a KYC request","description":"Retrieves a KYC request with a specified ID."}},"httpPath":"/kyc-requests/{id}"},{"label":"Update a KYC request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/patchkycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/patchkycrequest","metadata":{"seo":{"title":"Update a KYC request","description":"Updates a KYC request with a specified ID."}},"httpPath":"/kyc-requests/{id}"},{"label":"Delete the KYC request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/deletekycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/deletekycrequest","metadata":{"seo":{"title":"Delete the KYC request","description":"Deletes a KYC request with a specified ID."}},"httpPath":"/kyc-requests/{id}"},{"label":"Retrieve KYC documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycdocumentcollection","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycdocumentcollection","metadata":{"seo":{"title":"Retrieve KYC documents","description":"Retrieves a list of KYC documents."}},"httpPath":"/kyc-documents"},{"label":"Create a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocument","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocument","metadata":{"seo":{"title":"Create a KYC document","description":"Creates a KYC document."}},"httpPath":"/kyc-documents"},{"label":"Retrieve a KYC document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycdocument","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycdocument","metadata":{"seo":{"title":"Retrieve a KYC document","description":"Retrieves a KYC document with a specified ID."}},"httpPath":"/kyc-documents/{id}"},{"label":"Upsert a KYC document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/putkycdocument","routeSlug":"/docs/dev-docs/api/kyc-documents/putkycdocument","metadata":{"seo":{"title":"Upsert a KYC document","description":"Creates or updates (upserts) a KYC document with a specified ID."}},"httpPath":"/kyc-documents/{id}"},{"label":"Accept a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentacceptance","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentacceptance","metadata":{"seo":{"title":"Accept a KYC document","description":"Accepts a KYC document and changes the documents status to accepted.The review time and reviewer information is also updated."}},"httpPath":"/kyc-documents/{id}/acceptance"},{"label":"Update KYC document matches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentmatches","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentmatches","metadata":{"seo":{"title":"Update KYC document matches","description":"Updates the document matches of a KYC document with a specified ID."}},"httpPath":"/kyc-documents/{id}/matches"},{"label":"Reject a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentrejection","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentrejection","metadata":{"seo":{"title":"Reject a KYC document","description":"Rejects a KYC document and changes the status to rejected.The review time and reviewer information is also updated."}},"httpPath":"/kyc-documents/{id}/rejection"},{"label":"Review a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentreview","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentreview","metadata":{"seo":{"title":"Review a KYC document","description":"Updates the reviewTime and reviewerId of a KYC document with a specified ID."}},"httpPath":"/kyc-documents/{id}/review"},{"label":"Start review of a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentstartreview","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentstartreview","metadata":{"seo":{"title":"Start review of a KYC document","description":"Starts the review process of a KYC document with a specified ID."}},"httpPath":"/kyc-documents/{id}/start-review"},{"label":"Stop review of a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentstopreview","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentstopreview","metadata":{"seo":{"title":"Stop review of a KYC document","description":"Stops the review of a KYC document with a specified ID."}},"httpPath":"/kyc-documents/{id}/stop-review"},{"label":"Retrieve KYC settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycsettings","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycsettings","metadata":{"seo":{"title":"Retrieve KYC settings","description":"Retrieves KYC settings."}},"httpPath":"/kyc-settings"},{"label":"Update KYC settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/putkycsettings","routeSlug":"/docs/dev-docs/api/kyc-documents/putkycsettings","metadata":{"seo":{"title":"Update KYC settings","description":"Updates KYC settings."}},"httpPath":"/kyc-settings"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"KYC document accepted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-accepted","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-accepted","metadata":{"seo":{"title":"KYC document accepted","description":"KYC document accepted"}},"httpPath":"kyc-document-accepted"},{"label":"KYC document created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-created","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-created","metadata":{"seo":{"title":"KYC document created","description":"KYC document created"}},"httpPath":"kyc-document-created"},{"label":"KYC document modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-modified","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-modified","metadata":{"seo":{"title":"KYC document modified","description":"KYC document modified"}},"httpPath":"kyc-document-modified"},{"label":"KYC document rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-rejected","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-rejected","metadata":{"seo":{"title":"KYC document rejected","description":"KYC document rejected"}},"httpPath":"kyc-document-rejected"},{"label":"KYC document reviewed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-reviewed","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-reviewed","metadata":{"seo":{"title":"KYC document reviewed","description":"KYC document reviewed"}},"httpPath":"kyc-document-reviewed"},{"label":"KYC document archived","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-archived","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-archived","metadata":{"seo":{"title":"KYC document archived","description":"KYC document archived"}},"httpPath":"kyc-document-archived"},{"label":"KYC request attempted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-attempted","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-attempted","metadata":{"seo":{"title":"KYC request attempted","description":"KYC request attempted"}},"httpPath":"kyc-request-attempted"},{"label":"KYC request failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-failed","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-failed","metadata":{"seo":{"title":"KYC request failed","description":"KYC request failed"}},"httpPath":"kyc-request-failed"},{"label":"KYC request fulfilled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-fulfilled","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-fulfilled","metadata":{"seo":{"title":"KYC request fulfilled","description":"KYC request fulfilled"}},"httpPath":"kyc-request-fulfilled"},{"label":"KYC request partially fulfilled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-partially-fulfilled","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-partially-fulfilled","metadata":{"seo":{"title":"KYC request partially fulfilled","description":"KYC request partially fulfilled"}},"httpPath":"kyc-request-partially-fulfilled"}]},{"type":"group","label":"AML","link":"/docs/dev-docs/api/aml","routeSlug":"/docs/dev-docs/api/aml","items":[{"label":"Retrieve AML checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/getamlcheckcollection","routeSlug":"/docs/dev-docs/api/aml/getamlcheckcollection","metadata":{"seo":{"title":"Retrieve AML checks","description":"Retrieves a list of AML checks. These checks are records of customer data and potentially matching data in AML lists."}},"httpPath":"/aml-checks"},{"label":"Retrieve an AML check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/getamlcheck","routeSlug":"/docs/dev-docs/api/aml/getamlcheck","metadata":{"seo":{"title":"Retrieve an AML check","description":"Retrieves the results of a customer's AML check. Customer metadata and an array of matching AML hits is returned."}},"httpPath":"/aml-checks/{id}"},{"label":"Start review of an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/postamlcheckstartreview","routeSlug":"/docs/dev-docs/api/aml/postamlcheckstartreview","metadata":{"seo":{"title":"Start review of an AML check","description":"Starts the manual review process for an AML check with a specified ID."}},"httpPath":"/aml-checks/{id}/start-review"},{"label":"Stop review of an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/postamlcheckstopreview","routeSlug":"/docs/dev-docs/api/aml/postamlcheckstopreview","metadata":{"seo":{"title":"Stop review of an AML check","description":"Stops the manual review process for an AML check with a specified ID."}},"httpPath":"/aml-checks/{id}/stop-review"},{"label":"Review an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/postamlcheckreview","routeSlug":"/docs/dev-docs/api/aml/postamlcheckreview","metadata":{"seo":{"title":"Review an AML check","description":"Reviews an AML check. The AML check can be either confirmed or marked as a false positive."}},"httpPath":"/aml-checks/{id}/review"},{"label":"Retrieve AML settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/getamlsettings","routeSlug":"/docs/dev-docs/api/aml/getamlsettings","metadata":{"seo":{"title":"Retrieve AML settings","description":"Retrieves AML settings."}},"httpPath":"/aml-settings"},{"label":"Update AML settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/putamlsettings","routeSlug":"/docs/dev-docs/api/aml/putamlsettings","metadata":{"seo":{"title":"Update AML settings","description":"Updates AML settings."}},"httpPath":"/aml-settings"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"AML list possibly matched","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/aml/aml-list-possibly-matched","routeSlug":"/docs/dev-docs/api/aml/aml-list-possibly-matched","metadata":{"seo":{"title":"AML list possibly matched","description":"AML list possibly matched"}},"httpPath":"aml-list-possibly-matched"}]},{"type":"group","label":"Risk score","link":"/docs/dev-docs/api/risk-score","routeSlug":"/docs/dev-docs/api/risk-score","items":[{"label":"Retrieve risk score rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/getriskscorerules","routeSlug":"/docs/dev-docs/api/risk-score/getriskscorerules","metadata":{"seo":{"title":"Retrieve risk score rules","description":"Retrieves risk score rules."}},"httpPath":"/risk-score-rules"},{"label":"Modify risk score rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/putriskscorerules","routeSlug":"/docs/dev-docs/api/risk-score/putriskscorerules","metadata":{"seo":{"title":"Modify risk score rules","description":"Modifies risk score rules."}},"httpPath":"/risk-score-rules"},{"label":"Retrieve risk score blocklist rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/getriskscoreblocklistrules","routeSlug":"/docs/dev-docs/api/risk-score/getriskscoreblocklistrules","metadata":{"seo":{"title":"Retrieve risk score blocklist rules","description":"Retrieves risk score blocklist rules."}},"httpPath":"/risk-score-rules/blocklists"},{"label":"Modify risk score blocklist rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/putriskscoreblocklistrules","routeSlug":"/docs/dev-docs/api/risk-score/putriskscoreblocklistrules","metadata":{"seo":{"title":"Modify risk score blocklist rules","description":"Modifies risk score blocklist rules."}},"httpPath":"/risk-score-rules/blocklists"}]},{"type":"separator","label":"Misc"},{"type":"group","label":"Custom fields","link":"/docs/dev-docs/api/custom-fields","routeSlug":"/docs/dev-docs/api/custom-fields","items":[{"label":"Retrieve custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/custom-fields/getcustomfieldcollection","routeSlug":"/docs/dev-docs/api/custom-fields/getcustomfieldcollection","metadata":{"seo":{"title":"Retrieve custom fields","description":"Retrieves the custom fields schema for a specified resource."}},"httpPath":"/custom-fields/{resource}"},{"label":"Retrieve a custom field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/custom-fields/getcustomfield","routeSlug":"/docs/dev-docs/api/custom-fields/getcustomfield","metadata":{"seo":{"title":"Retrieve a custom field","description":"Retrieves a specified custom field schema for a specified resource."}},"httpPath":"/custom-fields/{resource}/{name}"},{"label":"Create or alter a custom field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/custom-fields/putcustomfield","routeSlug":"/docs/dev-docs/api/custom-fields/putcustomfield","metadata":{"seo":{"title":"Create or alter a custom field","description":"Creates or alters a specified custom field schema for a specified resource."}},"httpPath":"/custom-fields/{resource}/{name}"}]},{"type":"group","label":"Files","link":"/docs/dev-docs/api/files","routeSlug":"/docs/dev-docs/api/files","items":[{"label":"Retrieve attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getattachmentcollection","routeSlug":"/docs/dev-docs/api/files/getattachmentcollection","metadata":{"seo":{"title":"Retrieve attachments","description":"Retrieves a list of attachments. You may sort attachments by: id,name, relatedId, relatedType, fileId, createdTime,and updatedTime."}},"httpPath":"/attachments"},{"label":"Create an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/postattachment","routeSlug":"/docs/dev-docs/api/files/postattachment","metadata":{"seo":{"title":"Create an attachment","description":"Attaches a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities."}},"httpPath":"/attachments"},{"label":"Retrieve an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getattachment","routeSlug":"/docs/dev-docs/api/files/getattachment","metadata":{"seo":{"title":"Retrieve an attachment","description":"Retrieves an attachment with a specified ID."}},"httpPath":"/attachments/{id}"},{"label":"Update an attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/putattachment","routeSlug":"/docs/dev-docs/api/files/putattachment","metadata":{"seo":{"title":"Update an attachment","description":"Updates an attachment with a specified ID."}},"httpPath":"/attachments/{id}"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/deleteattachment","routeSlug":"/docs/dev-docs/api/files/deleteattachment","metadata":{"seo":{"title":"Delete an attachment","description":"Deletes an attachment with a specified ID."}},"httpPath":"/attachments/{id}"},{"label":"Retrieve files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getfilecollection","routeSlug":"/docs/dev-docs/api/files/getfilecollection","metadata":{"seo":{"title":"Retrieve files","description":"Retrieves a list of files."}},"httpPath":"/files"},{"label":"Create a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/postfile","routeSlug":"/docs/dev-docs/api/files/postfile","metadata":{"seo":{"title":"Create a file","description":"Creates a file."}},"httpPath":"/files"},{"label":"Retrieve a file record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getfile","routeSlug":"/docs/dev-docs/api/files/getfile","metadata":{"seo":{"title":"Retrieve a file record","description":"Retrieves a file with a specified ID."}},"httpPath":"/files/{id}"},{"label":"Update a file","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/putfile","routeSlug":"/docs/dev-docs/api/files/putfile","metadata":{"seo":{"title":"Update a file","description":"Updates a file with a specified ID."}},"httpPath":"/files/{id}"},{"label":"Delete a file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/deletefile","routeSlug":"/docs/dev-docs/api/files/deletefile","metadata":{"seo":{"title":"Delete a file","description":"Deletes a file with a specified ID."}},"httpPath":"/files/{id}"},{"label":"Download a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getfiledownload","routeSlug":"/docs/dev-docs/api/files/getfiledownload","metadata":{"seo":{"title":"Download a file","description":"Downloads a file with a specified ID."}},"httpPath":"/files/{id}/download"}]},{"type":"group","label":"Search","link":"/docs/dev-docs/api/search","routeSlug":"/docs/dev-docs/api/search","items":[{"label":"Search merchant data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/search/getsearch","routeSlug":"/docs/dev-docs/api/search/getsearch","metadata":{"seo":{"title":"Search merchant data","description":"Searches merchant data to return resources such as customers, invoices, orders, transactions."}},"httpPath":"/search"}]}],"menuStyle":"drilldown"},{"type":"link","fsPath":"docs/dev-docs/webhooks-configuration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Webhook configuration","link":"/docs/dev-docs/webhooks-configuration","routeSlug":"/docs/dev-docs/webhooks-configuration"},{"type":"link","fsPath":"docs/dev-docs/create-a-hosted-payment-form.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Hosted payment API integration","link":"/docs/dev-docs/create-a-hosted-payment-form","routeSlug":"/docs/dev-docs/create-a-hosted-payment-form"},{"type":"link","fsPath":"docs/dev-docs/hosted-payout-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Hosted payout API integration","link":"/docs/dev-docs/hosted-payout-integration","routeSlug":"/docs/dev-docs/hosted-payout-integration"},{"type":"link","fsPath":"docs/dev-docs/create-a-kyc-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Request KYC docs API guide","link":"/docs/dev-docs/create-a-kyc-integration","routeSlug":"/docs/dev-docs/create-a-kyc-integration"},{"type":"link","fsPath":"docs/dev-docs/create-a-direct-integration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Direct transaction API integration","link":"/docs/dev-docs/create-a-direct-integration","routeSlug":"/docs/dev-docs/create-a-direct-integration"},{"type":"link","fsPath":"docs/dev-docs/search-filters.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Search filters","link":"/docs/dev-docs/search-filters","routeSlug":"/docs/dev-docs/search-filters"},{"type":"link","fsPath":"docs/dev-docs/export-configuration.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Export configuration","link":"/docs/dev-docs/export-configuration","routeSlug":"/docs/dev-docs/export-configuration"},{"type":"link","fsPath":"docs/dev-docs/expand-embedded-resources.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Embedded resources","link":"/docs/dev-docs/expand-embedded-resources","routeSlug":"/docs/dev-docs/expand-embedded-resources"},{"type":"link","fsPath":"docs/dev-docs/pgp-public-key.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"PGP public key","link":"/docs/dev-docs/pgp-public-key","routeSlug":"/docs/dev-docs/pgp-public-key"},{"type":"link","fsPath":"docs/dev-docs/resource-prefixes.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Resource ID prefix guide","link":"/docs/dev-docs/resource-prefixes","routeSlug":"/docs/dev-docs/resource-prefixes"},{"type":"separator","label":"Testing"},{"type":"link","fsPath":"docs/tutorials/test-transactions.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Test payment transactions","link":"/docs/tutorials/test-transactions","items":[{"type":"link","fsPath":"docs/tutorials/test-payment-cards.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Test payment cards, IBANs, and ACH details","link":"/docs/tutorials/test-payment-cards","routeSlug":"/docs/tutorials/test-payment-cards"},{"type":"link","fsPath":"docs/tutorials/test-transactions-sandbox.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Run test transactions in the sandbox","link":"/docs/tutorials/test-transactions-sandbox","routeSlug":"/docs/tutorials/test-transactions-sandbox"},{"type":"link","fsPath":"docs/tutorials/test-generic-offsite-approval-flow.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Test a generic offsite approval flow","link":"/docs/tutorials/test-generic-offsite-approval-flow","routeSlug":"/docs/tutorials/test-generic-offsite-approval-flow"},{"type":"link","fsPath":"docs/tutorials/test-3ds-flow.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Test a 3ds challenge flow","link":"/docs/tutorials/test-3ds-flow","routeSlug":"/docs/tutorials/test-3ds-flow"},{"type":"link","fsPath":"docs/tutorials/test-environments-and-live-checklist.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Environment and live checklist","link":"/docs/tutorials/test-environments-and-live-checklist","routeSlug":"/docs/tutorials/test-environments-and-live-checklist"}],"routeSlug":"/docs/tutorials/test-transactions"},{"type":"link","fsPath":"docs/dev-docs/apple-pay-testing.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Apple Pay testing","link":"/docs/dev-docs/apple-pay-testing","routeSlug":"/docs/dev-docs/apple-pay-testing"},{"type":"separator","label":"Miscellaneous"},{"type":"link","fsPath":"docs/dev-docs/manage-apps.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Manage apps","link":"/docs/dev-docs/manage-apps","routeSlug":"/docs/dev-docs/manage-apps"},{"type":"link","fsPath":"docs/dev-docs/lead-source-attribution.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Lead source attribution","link":"/docs/dev-docs/lead-source-attribution","routeSlug":"/docs/dev-docs/lead-source-attribution"},{"type":"link","fsPath":"docs/dev-docs/transaction-reconciliation.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Transaction reconciliation","link":"/docs/dev-docs/transaction-reconciliation","routeSlug":"/docs/dev-docs/transaction-reconciliation"},{"type":"link","fsPath":"docs/dev-docs/ip-addresses.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"IP address allow lists","link":"/docs/dev-docs/ip-addresses","routeSlug":"/docs/dev-docs/ip-addresses"},{"type":"link","fsPath":"docs/dev-docs/migrate-subscriptions-from-another-platform.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Migrate subscriptions from another platform","link":"/docs/dev-docs/migrate-subscriptions-from-another-platform","routeSlug":"/docs/dev-docs/migrate-subscriptions-from-another-platform"}],"menuStyle":"drilldown"},{"type":"link","link":"docs/dev-docs/api/index.yaml","label":"Rebilly API"},{"type":"group","fsPath":"docs/kyc-and-aml/index.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC & AML","link":"/docs/kyc-and-aml","routeSlug":"/docs/kyc-and-aml","items":[{"type":"group","fsPath":"docs/kyc-and-aml/kyc.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC","link":"/docs/kyc-and-aml/kyc","routeSlug":"/docs/kyc-and-aml/kyc","items":[{"type":"link","fsPath":"docs/kyc-and-aml/kyc-document-gatherer.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"KYC document gatherer","link":"/docs/kyc-and-aml/kyc-document-gatherer","routeSlug":"/docs/kyc-and-aml/kyc-document-gatherer"}]},{"type":"link","fsPath":"docs/kyc-and-aml/aml.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"AML","link":"/docs/kyc-and-aml/aml","routeSlug":"/docs/kyc-and-aml/aml"}],"menuStyle":"drilldown"},{"type":"link","fsPath":"docs/glossary.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Glossary","link":"/docs/glossary","routeSlug":"/docs/glossary"},{"type":"link","fsPath":"docs/rebilly-faqs.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"FAQs","link":"/docs/rebilly-faqs","routeSlug":"/docs/rebilly-faqs"},{"type":"link","fsPath":"docs/release-notes.md","metadata":{"redocly_category":"Documentation","type":"markdown"},"label":"Release notes","link":"/docs/release-notes","routeSlug":"/docs/release-notes"}]}