openapi: 3.1.1
info:
  version: "latest"
  title: Rebilly API
  contact:
    name: "Rebilly API Support"
    url: "https://www.rebilly.com/contact/"
    email: "integrations@rebilly.com"
  license:
    name: "Rebilly"
    url: 'https://www.rebilly.com/api-license/'
  termsOfService: 'https://www.rebilly.com/terms-of-use/'
  x-logo:
    url: 'https://rebilly-core.redoc.ly/rb_apiLogo.svg'
    backgroundColor: '#0044d4'
  description:
    $ref: description.md

security:
  - SecretApiKey: []
  - JWT: []

servers:
  - url: 'https://api-sandbox.rebilly.com/organizations/{organizationId}'
    description: Sandbox server
    variables:
      organizationId:
        default: '{organizationId}'
        description: |-
          Unique organization identifier.
          An organization is an entity that represents a company.
          For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
  - url: 'https://api.rebilly.com/organizations/{organizationId}'
    description: Live server
    variables:
      organizationId:
        default: '{organizationId}'
        description: |-
          Unique organization identifier.
          An organization is an entity that represents a company.
          For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

components:
  securitySchemes:
    JWT:
      description: |-
        JWT is a short lifetime token that can be assigned a specific expiration time.

        Usage format: `Bearer <JWT>`.
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApplicationJWT:
      description: |-
        Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance.
        For more information, see [Retrieve an application instance](https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/).

        Usage format: `Bearer <JWT>`.
      type: http
      scheme: bearer
      bearerFormat: JWT

    PublishableApiKey:
      description: |-
        This authentication method is applicable to specific operations.

        To create a publishable API key, see [Create an API key](https://www.rebilly.com/catalog/all/api-keys/postapikey).
      name: Authorization
      type: apiKey
      in: header

    SecretApiKey:
      description: |-
        Never share your secret keys.
        Keep them guarded and secure.

        Use your secret API key only to make requests from the server side.
        To authenticate, provide your secret key in the request header.
      name: REB-APIKEY
      type: apiKey
      in: header

    CustomerJWT:
      description: |-
        To create a JSON Web Token (JWT) using Storefront authentication,
        see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin).

        Usage format: `Bearer <JWT>`.
      type: http
      scheme: bearer
      bearerFormat: JWT

tags:
  - name: Account registration settings
    description: Use account registration settings operations to configure the fields and steps that customers see during account registration.
  - name: Allowlists
    description: |-
      Use allowlists to exclude specific customer attribute data from risk score checks.

      Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a [blocklist record](https://www.rebilly.com/docs/automations/blocklists/) when a [risk score](https://www.rebilly.com/docs/automations/risk-scoring/) threshold reached.
  - name: AML
    description: |-
      Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.

      Use AML operations during customer creation, and some transaction processing,
      to help determine if a potential customer (lead), or customer, has political or economic sanctions against them.

      AML operations search the following for screening purposes:
      Politically Exposed Persons (PEPs) lists, sanction lists,
      and adverse media lists.
  - name: API keys
    description: |-
      Use API keys to identify and authenticate applications and users.
      Always keep your API keys private.
      When creating API keys, you can restrict them to a given set of permissions.
      For information on how to create and manage API keys, see [API keys](https://www.rebilly.com/docs/dev-docs/api-keys/).
  - name: Application owners
    description: |-
      Use application owner operations to register applications to the Rebilly App Store,
      and manage application instances.
      An application owner is a person or organization that submits an app to the Rebilly App Store.
      For more information on submitting apps, see [Submit an app](https://www.rebilly.com/docs/dev-docs/submit-a-rebilly-app/).
  - name: Application users
    description: |-
      Use application user operations to browse available apps in the Rebilly App Store,
      and to manage installed application instances in your organization.
      An application user is a person or organization that uses an app that is installed from the Rebilly App Store.
      For more information, see [Install or uninstall an app](https://www.rebilly.com/docs/dev-docs/install-an-app/).
  - name: Balance transactions
    description: |-
      Use these operations to view and manage balance transactions.

      > **Important:** These operations are experimental and may change.
  - name: Billing portals
    description: |-
      Use these operations to create and manage billing portals.
      Rebilly hosted billing portals provide secure, Rebilly hosted pages, where customers can:
      view invoices, cancel subscriptions, update payment instruments, and update their address.
  - name: Blocklists
    description: |-
      Use blocklists to prevent fraud and criminal activity.

      Blocklists are lists of customer attribute values that are blocked from buying from you.
      For example, if a customer attempts to make a purchase from you with a credit card that is in a blocklist, the transaction is blocked and is not processed.

      Before a new transaction is processed in Rebilly, blocklists are examined to check for attributes related to the entity.
      If a match is detected, the operation is aborted.
      A blocklist that expires after a period of time is called a greylist.
  - name: Broadcast messages
    description: |-
      Use broadcast messages to notify customers and leads about upcoming promotions, service updates, and events.
      Broadcast messages are emails that are sent to a specific group of customers, or all customers.
      For more information, see [Create a broadcast message](https://www.rebilly.com/docs/automations/email-notifications/#create-broadcast-messages).
  - name: Cashiers
    description: |-
      Use these operations to create and manage cashiers.

      > **Important:** These operations are experimental and may change.

      Cashiers are customer-scoped configuration resources that define the deposit and payout (withdrawal) settings for a specific customer, website, and currency.
  - name: Checkout forms
    description: |-
      Use these operations to create and manage checkout forms.
      Rebilly hosted checkout forms provide secure and compliant checkouts.
      Checkout forms are customizable, and use fully responsive design,
      built-in error messaging, validation, and expedited checkout for returning customers.
  - name: Coupons
    description: |-
      Use coupons to reward customers, generate sales, or to test new pricing strategies.
      Coupons enable you to apply different types of discounts to invoices, subscriptions, and pricing plans.

      Redeemed coupons are attached to a customer's account.
      Depending on the coupon restrictions, the redeemed coupons are then applied from the customer's account to subsequent invoices or subscriptions.
      Redeemed coupons can only be applied to invoices of the same currency.

      Once a coupon is redeemed it cannot be modified.
      You may deactivate a coupon or create a new coupon, but you cannot reuse the same coupon code.
      If you have a use case where you must reuse the same code, [contact Rebilly](https://www.rebilly.com/contact/).

      ### Coupon restriction types

      The following coupon description types are available:

      - `restrict-to-countries`: Restricts a coupon for use in specific countries.
      - `discounts-per-redemption`: Restricts the number of times that the coupon can be applied by one redemption.
        For example, use this restriction to configure a coupon that can only be applied to the first subscription renewal of a particular product.
      - `minimum-order-amount`: Sets a minimum order amount for a coupon application.
        For example, if the restriction amount is $20, the coupon is only applied to invoices with a total amount of $20 or more.
      - `restrict-to-invoices`: Restricts a coupon to specific invoices.
      - `restrict-to-plans`: Restricts a coupon to specific pricing plans.
      - `restrict-to-subscriptions`: Restricts a coupon to specific order subscriptions.
      - `restrict-to-customer-tags`: Restricts a coupon to customers with specific tags.
      - `restrict-to-customers`: Restricts a coupon to specific customers.
      - `restrict-to-exclusive-application`: Restricts a coupon so that it cannot be used in combination with other coupons. If more than one coupon is active, a coupon with this restriction is only applied if it provides a larger discount than the other coupons combined. If a coupon with this restriction is applied, all other coupons are removed.
      - `restrict-to-products`: Restricts a coupon to specific products.
      - `paid-by-time`: Specifies a date and time at which a coupon redemption expires if not paid.
      - `redemptions-per-customer`: Restricts the number of times that a coupon can be redeemed by one customer.
        For example, use this restriction to limit the number of redemptions to one per customer.
      - `total-redemptions`: Restricts the number of times a coupon can be redeemed by different customers.
      - `restrict-to-bxgy`: Provides "buy X get Y" promotions.
        These promotions incentivize new customers to buy and also reward existing customers.
        This restriction type enables you to add discounted plans to an invoice when a certain quantity of other plans are purchased.
        For example, if a customer buys two or more books, they get one free bookmark.
  - name: Credit memos
    description: |-
      Use credit memos to provide a customer with store credit.
      A common use case for using a credit memo is to provide a customer with store credit,
      rather than a refund, if the customer pays more than they owe or returns a product.
      For information on the credit memo resource, see [Resources](https://www.rebilly.com/docs/dev-docs/concepts/#resources).
  - name: Credit memos timeline
    description: |-
      Use credit memo timelines to maintain an audit trail of changes and activity for each credit memo.
      Credit memos are a means of providing a customer with store credit.
  - name: Custom domains
    description: |-
      Use custom domains to configure and use your own domain for forms and billing portals,
      instead of the default Rebilly domain: `portal.secure-payments.app`.
      For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites#configure-a-custom-domain).
  - name: Custom fields
    description: |-
      Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
      Depending on the resource on which the custom field is added, it may be available in the Rebilly UI.

      Example: A custom field called `preferredCommunicationChannel` is added to the customer resource.
      It has two allowed values, which are 'email' and 'phone'.

      ```js
      {
        "customFields": {
            "preferredCommunicationChannel": "email"
        }
      }
      ```

      For detailed information on Rebilly resources, see [Resources](https://www.rebilly.com/docs/dev-docs/concepts/#resources).
  - name: Customer authentication
    description: Use these operations to validate the identity of users and manage authentication credentials.
  - name: Customers
    description: |-
      Use these operations to manage customers.
      A customer is an entity that purchases goods or services from you (a merchant),
      and is the payee in any transaction that is credited to you.
      Customers are associated with payment instruments,
      subscriptions, invoices, and other related resources.

      In other systems, customers may be referred to as accounts,
      clients, members, patrons, or players.
      For information on the customer resource, see [Resources](https://www.rebilly.com/docs/dev-docs/concepts/#resources).
  - name: Customers timeline
    description: Use customer timelines to maintain an audit trail of changes and activity for each customer.
  - name: Dashboards
    description: |-
      Use dashboard operations to manage the user's dashboard and its tabs with metrics over key performance indicators.
      Each tab is a customizable view of tiles that display report data.
  - name: Data exports
    description: |-
      Use data export operations to manage the export of resource data, such as:
      transactions, customers, subscriptions, invoices, or invoice item data.
      Common data export use cases are:
      accounting, data analysis, reporting, or importing into other databases.

      For detailed information on Rebilly resources,
      see [Resources](https://www.rebilly.com/docs/dev-docs/concepts/#resources).

      For information on how manage reconciliation, see [Transaction reconciliation](https://www.rebilly.com/docs/dev-docs/transaction-reconciliation).
  - name: Deposits
    description: |-
      Create and manage deposit requests and manage strategies that determine the deposit amounts to display on the page.
      Rebilly hosted deposit form provides a secure and compliant way to deposit funds.
      Deposit forms are customizable, and use fully responsive design, built-in error messaging and validation.

      > **Important:** These operations are experimental and may change.
  - name: Disputes
    description: |-
      Use these operations to manage disputes.
      A dispute occurs when a customer contests a charge to their account.
      The dispute and related information is made available to the merchant by the bank or credit card company.
      The merchant then has the option to represent the charge and win the case.
      This process is called dispute resolution.
      If the merchant is unable to represent the charge, the card issuer typically reverses the sale and adds fees on top of the charge.
      This process is called a chargeback.
  - name: Email delivery settings
    description: |-
      Use email delivery settings to configure from which email address notifications and broadcast message are sent.
      In Rebilly, this email address is referred to as a "From address".
      Supported email service providers are:
      SMTP, Mailgun, SendGrid, AWS SES, Postmark, and Rebilly.
  - name: Email messages
    description: Use email messages to email customers directly.
  - name: Email notifications
    description: |-
      Use email notifications to keep customers informed on events,
      and to inform them of events that may require action on their end.
      Email notifications are targeted email messages that can be plain text or HTML.

      Email notifications can also be used to notify teammates about new customers, blocklist matches, risk score changes, and more.
      For more information, see [Email notifications](https://www.rebilly.com/docs/automations/email-notifications/).
  - name: External identifiers
    description: |-
      Use external identifier operations to associate entities such as customers,
      invoices, transactions, journal accounts, journal entries,
      and more with external services.

      To use external identifiers, you must use an active service credential.
  - name: Fees
    description: |-
      Use fees to reconcile transactions with applicable fees and discount rates.
      Fees are not applied directly to transaction amounts, they do not modify the transaction amount.
      Fees help to describe each part of the transaction amount.

      > **Important:** These operations are experimental and may change.
  - name: Files
    description: |-
      Use the file entity to store files and related metadata.
      Files can be sorted by size, MIME-type, user-defined tags, and description.

      The following methods are available to upload files:
      multipart/form-data encoded form, RAW POST &mdash;
      by sending the file contents as the POST body, and fetching from URL &mdash;
      by providing the file URL using the 'url' parameter.

      Use the attachments entity to link 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.
  - name: Gateway accounts
    description: |-
      Use these operations to manage payment gateway accounts.
      A payment gateway is a service which enables merchants to receive payments from their customers to their merchant account.
      A merchant account is a bank account that enables businesses to receive payments.
      Use payment gateway accounts to connect payment requests to third party networks and platforms.
  - name: Gateway accounts timeline
    description: Use gateway account timelines to maintain an audit trail of changes and activity for each gateway account.
  - name: Histograms
    description: |-
      Use histogram operations to generate transaction histogram reports with cohorts and periods.
      For information on the invoice resource, see [Resources](https://www.rebilly.com/docs/dev-docs/concepts/#resources).
  - name: Integrations
    description: |-
      Use these operations to manage third-party apps that are integrated to your Rebilly account.
      For more information on third-party apps, and how to integrate them,
      see [App store](https://www.rebilly.com/docs/app-store/app-store/).
  - name: Invoices
    description: |-
      Use invoices to bill for the goods or services that you provide.
      If your invoice includes subscription items, it also includes the corresponding service periods and prices.
  - name: Invoices timeline
    description: Use invoice timelines to maintain an audit trail of changes and activity for each invoice.
  - name: Journal
    description: Use journal accounts, entries and records to track and recognize revenue.
  - name: KYC documents
    description: |-
      Use Know Your Customer (KYC) documents to verify your customers identity.
      The KYC document operations generate a signed link to the Rebilly [KYC document gatherer](https://www.rebilly.com/docs/kyc-and-aml/kyc-document-gatherer/).

      Document types:
        - `identity-proof`: Validates a customer's identity.
        - `address-proof`: Validates a customer's address.
        - `purchase-proof`: Validates a customer's purchase.
        - `funds-proof`: Validates that a customer has funds.
        - `credit-file-proof`: Verifies that there is an existing credit file with two sources that match the customer's name, DOB, and address.

      Rebilly parses and analyzes the documents and accepts or rejects them according to a configurable scoring algorithm.
      When all document types in a KYC request are accepted, the status is fulfilled, and the [KYC request fulfilled webhook](https://www.rebilly.com/docs/dev-docs/api/kyc-documents/kyc-request-fulfilled/) is sent.

      ### Credit file proof

      The `credit-file-proof` KYC document request type is only available in the API,
      this option is not available in the [KYC document gatherer](https://www.rebilly.com/docs/kyc-and-aml/kyc-document-gatherer/).
      This request verifies that there is an existing credit file with two sources that match the person's name, date of birth, and address.

      In Canada, to meet FINTRAC requirements, the `credit-file-proof` KYC document request verifies the customer's name, address, and date of birth with a credit agency.

      If `credit-file-proof` is requested in combination with `identity-proof` and `address-proof`,
      `credit-file-proof` is attempted first.
      If `credit-file-proof` validates the identity and address,
      the KYC request is considered fulfilled.
      If the request is not fulfilled,
      redirect your customer to the KYC document gatherer to collect their KYC documents.

  - name: Lists
    description: |-
      Use lists to create and maintain sets of values that may be referenced in rule conditions.
      Commonly used lists contain values related to conditions that target specific properties such as: customers, transactions, or BINs.

      You may grant list edit permissions to members of your team without enabling them to edit rules.
      This may be useful if your workflow involves frequent updates to value sets that are used in rule or bind conditions.
      List order may not be maintained and duplicates may be removed.

      For more information, see [Value lists](https://www.rebilly.com/docs/automations/create-a-value-list/#value-lists).
  - name: Memberships
    description: |-
      Use these operations to manage user membership within your organizations.
      Membership describes the relationship between organizations and users.
      For example, one user could be a member of more than one organization.
  - name: Metadata
    description: |-
      Use these operations to retrieve and manage metadata.
      Metadata is structured information on other data.
  - name: Orders
    description: |-
      Use these operations to manage customer orders.
      An order is a customer's request to purchase items.
      It can contain subscription and one-time sale items.
      When an order contains one or more subscription items, it is a subscription order.

      An order generates an invoice.
      A subscription order generates an invoice for each service period.
      For more information, see [Orders](https://www.rebilly.com/docs/dev-docs/concepts/#orders).
  - name: Orders experimental
    description: Use these operations to manage orders that include items with mixed recurring subscription plans.
  - name: Orders timeline
    description: Use order timelines to maintain an audit trail of changes and activity for each order.
  - name: Organization data exports
    description: |-
      Use organization data exports to export your organization data which you may want to do as a business continuity practice.
      These may also be used to to export data if you decide to migrate to a different payments solution.
  - name: Organizations
    description: |-
      Use these operations to manage your organizations in Rebilly.
      An organization is an entity that represents you, or your company, as a merchant.
      You can have multiple organizations.
      For more information, see [My organizations and websites](https://www.rebilly.com/docs/settings/organizations-and-websites/).

      Note: No data, including organizations, is shared between the live and sandbox environments.
  - name: Payment instruments
    description: |-
      Use these operations to manage payment instruments.
      Payment instrument is a term which describes any means of making a digital payment, such as:
      credit cards, debit cards, direct debits, payment service providers, and digital wallets.

      For more information on payment instruments, see [Payment instruments](https://www.rebilly.com/docs/dev-docs/concepts/#payment-instruments).
  - name: Payment tokens
    description: |-
      Use payment tokens to reduce the scope of [PCI DSS compliance](https://www.rebilly.com/docs/pci-compliance/).

      A payment token can be made using a different authentication scheme (public key authentication), which enables you to create a payment token directly from the browser.
      This bypasses the need to send sensitive cardholder info to your servers.
      We recommend using this with the FramePay library, which helps you integrate a form into this API resource and create payment tokens.
  - name: Plans
    description: |-
      Use pricing plans to describe how the customer must pay for [products](https://www.rebilly.com/docs/dev-docs/api/products/).

      Rebilly provides the following plan types:

      - Trial only: Use this plan to create and offer a free or discounted trial period for your product.
        For example, a free 2 week trial of an internet service.
        After the trial, the customer can choose to sign up for a paid subscription, or stop using the service.
      - Recurring: Use this plan to create and offer a subscription for your product.
        For example, a monthly subscription to an internet service that is charged at 20 USD per month.
      - One time sale: Use this plan to create and offer a one-off sale for your products.
        For example, a one time purchase of two bags of coffee.

      For information on the plans resource, see [Plans](https://www.rebilly.com/docs/dev-docs/concepts/#plans).

      For information on plan pricing, see [Pricing formulas](https://www.rebilly.com/docs/settings/pricing-formulas/).
  - name: Products
    description: |-
      Use products to describe the goods and services that your business sells.
      A product also describes sales items on invoices and receipts.
      Product pricing is defined in [plans](https://www.rebilly.com/docs/dev-docs/api/plans/).
      A product may have one or many plans.

      For information on the product resource, see [Product](https://www.rebilly.com/docs/dev-docs/concepts/#products).
  - name: Profile
    description: |-
      Use these operations to manage user profiles.
      A profile represents the person that is signed in to Rebilly.
  - name: Quotes
    description: |-
      Use quote operations to create and manage quotations.
      Quotations describe the cost of goods or services to potential customers before they commit to a purchase.
      A quote contains an initial invoice preview that can be accepted to become an order.

      A quote can contain subscription and one-time sale items.
      When a quote contains one or more subscription items, it is a subscription order quote.
  - name: Quotes timeline
    description: Use quote timelines to maintain an audit trail of changes and activity for each quote.
  - name: Reports
    description: Use reports operations to retrieve summary information about your customers, subscriptions, transactions, and more.
  - name: Reset password
    description: |-
      Use these operations to manage password resets.
      When a password reset is requested, an email with a token is sent.
      In the email the user must press a reset link, and then create a new password.
  - name: Risk score
    description: |-
      Use risk score operations to configure blocklists based on transaction risk factors.
  - name: Roles
    description: |-
      Use these operations to manage user roles within your team or organization.
      Roles are an implementation of the general hierarchical (Role Based Access Control) RBAC.
      A senior role inherits all of its juniors' Access Control Lists (ACLs) and its own ACL.
      Junior roles are not influenced by the senior role.
  - name: Rules
    description: |-
      Use rules to automate.
      In the Rebilly rules engine, an action is an operation that executes when an event occurs.
      Action and event conditions are defined in rules.
      Rulesets are collections of rules that are associated with an event.
      The order in which the rules are placed within a ruleset specifies the execution order.

      For a list of events and related actions, see [Events](https://www.rebilly.com/docs/automations/event-types/).
  - name: Rules timeline
    description: Use rule timelines to maintain an audit trail of changes and activity for each rule.
  - name: Search
    description: Use search operations to search data on customers, invoices, orders, transactions and more.
  - name: Segments
    description: |-
      Use these operations to manage UI segments.
      A segment is a filtered view of a data set that can be shared with other users.
      For example, you may create a transactions segment that displays specific columns that are filtered and sorted based on certain criteria,
      and share it with others in your organization.
  - name: Service credentials
    description: Use these operations to get, create, and manage credentials for third-party services.
  - name: Shipping rates
    description: |-
      Use these operations to manage shipping rates.
      A shipping rate contains a filter and a pricing for a specific shipping destination.
  - name: Status
    description: |-
      Use this operation to check the status of the Rebilly API.
      No authentication is required.
  - name: Storefront account
    description: |-
      Use these operations to manage Storefront accounts.
      A Storefront account is an account that the customer is subscribed to in order to use the Rebilly product.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).

      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront billing portals
    description: |-
      Use these operations to access Storefront billing portals.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront cashiers
    description: |-
      Use these operations to access Storefront cashiers.

      Cashiers are customer-scoped configuration resources that define the deposit and payout (withdrawal) settings for a specific customer, website, and currency.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.

      > **Important:** These operations are experimental and may change.
  - name: Storefront checkout forms
    description: |-
      Use these operations to access Storefront checkout forms.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront custom fields
    description: |-
      Use these operations to access Storefront custom fields.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront deposits
    description: |-
      Use these operations to access Storefront deposits.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront invoices
    description: |-
      Use these operations to access Storefront invoices.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront KYC documents
    description: |-
      Use these operations to access Storefront KYC documents.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront orders
    description: |-
      Use these operations to access Storefront orders.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront payment instruments
    description: |-
      Use these operations to access Storefront payment instruments.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront plans
    description: |-
      Use these operations to access Storefront plans.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront products
    description: |-
      Use these operations to access Storefront products.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information,
      see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront purchases
    description: |-
      Use these operations to manage Storefront purchases.
      Purchases are transactions that have been executed related to the purchase of goods or services.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront quotes
    description: |-
      Use these operations to access Storefront quotes.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront transactions
    description: |-
      Use these operations to access Storefront transactions.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Storefront websites
    description: |-
      Use these operations to access Storefront websites.

      Storefront operations interact directly with the customer,
      and provide the customer with access to their own data.

      To use Storefront operations,
      the customer must be issued a JWT with limited permissions.
      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/customer-authentication/postauthenticationtokenexchange).
      Storefront operations are intended to be used directly from an untrusted browser.
  - name: Tags
    description: Use tags to organize and categorize customers or KYC documents based on keywords.
  - name: Tracking
    description: |-
      Use tracking when debugging and auditing issues.
      Tracking is a layer for accessing all activity such as:
      API requests, subscriptions, webhooks, events, and more.
  - name: Transactions
    description: |-
      Use these operations to:
        - set up payment instruments for payments
        - authorize and hold funds
        - capture funds
        - make payments
        - make payouts
        - refund transactions.
  - name: Transactions timeline
    description: Use transaction timelines to maintain an audit trail of changes and activity for each transaction.
  - name: Usage
    description: |-
      Use these operations to manage the product usage of a subscription item for metered billing purposes.

      Use metered billing when product quantity is unknown to the customer at the moment of creating a subscription.
      Metered billing is based on reported usage records.
      Every reported usage updates the quantity of an upcoming invoice item for a specified subscription and a plan.
      To create a metered billing plan, see [Plans](../Plans).
  - name: Users
    description: |-
      Use these operations to manage users.
      A user is a person who can login to Rebilly, and take actions based on their granted permissions.
  - name: Webhooks
    description: |-
      Use these operations to manage webhooks.
      Webhooks notify your systems in real-time when certain events occur.
      For example, when a new transaction occurs or a new subscription is created.
      Webhooks enable you to collect information about events.
      Rebilly can send this information by HTTP POST request to a defined URL of your choice.
  - name: Websites
    description: |-
      Use these operations to manage websites.
      A website is where your organization obtains a customer.
      It is also the processor account and billing descriptor used for payment transactions.
      You can create multiple websites.

      Websites are related to each invoice and each payment gateway account.
      This enables you to associate gateway accounts with multiple websites,
      or make them exclusive to particular websites.
      For more information, see [My organizations and websites](https://www.rebilly.com/docs/settings/organizations-and-websites/).


x-tagGroups:
  - name: Customers
    tags:
      - Customers
      - Customer authentication
      - Account registration settings
      - Tags
      - Customers timeline
  - name: Payment Instruments
    tags:
      - Payment instruments
      - Payment tokens
  - name: Payments
    tags:
      - Transactions
      - Disputes
      - Fees
      - Transactions timeline
  - name: Orders & Invoices
    tags:
      - Orders
      - Invoices
      - Usage
      - Credit memos
      - Plans
      - Products
      - Coupons
      - Quotes
      - Quotes timeline
      - Shipping rates
      - Orders timeline
      - Invoices timeline
      - Credit memos timeline
  - name: Risk
    tags:
      - Blocklists
      - Allowlists
      - KYC documents
      - AML
      - Risk score
  - name: Misc
    tags:
      - Custom fields
      - Files
      - Search


paths:
  /account-registration-settings:
    $ref: ./paths/account-registration-settings.yaml
  '/account-registration-settings/{id}':
    $ref: ./paths/account-registration-settings@{id}.yaml
  /aml-checks:
    $ref: ./paths/aml-checks.yaml
  '/aml-checks/{id}':
    $ref: ./paths/aml-checks@{id}.yaml
  '/aml-checks/{id}/start-review':
    $ref: ./paths/aml-checks@{id}@start-review.yaml
  '/aml-checks/{id}/stop-review':
    $ref: ./paths/aml-checks@{id}@stop-review.yaml
  '/aml-checks/{id}/review':
    $ref: ./paths/aml-checks@{id}@review.yaml
  '/aml-settings':
    $ref: ./paths/aml-settings.yaml
  /attachments:
    $ref: ./paths/attachments.yaml
  '/attachments/{id}':
    $ref: ./paths/attachments@{id}.yaml
  /authentication-options:
    $ref: ./paths/authentication-options.yaml
  /authentication-tokens:
    $ref: ./paths/authentication-tokens.yaml
  '/authentication-tokens/{token}':
    $ref: ./paths/authentication-tokens@{token}.yaml
  '/authentication-tokens/{token}/exchange':
    $ref: ./paths/authentication-tokens@{token}@exchange.yaml
  /blocklists:
    $ref: ./paths/blocklists.yaml
  '/blocklists/{id}':
    $ref: ./paths/blocklists@{id}.yaml
  /coupons-redemptions:
    $ref: ./paths/coupons-redemptions.yaml
  '/coupons-redemptions/{id}':
    $ref: ./paths/coupons-redemptions@{id}.yaml
  '/coupons-redemptions/{id}/cancel':
    $ref: ./paths/coupons-redemptions@{id}@cancel.yaml
  /coupons:
    $ref: ./paths/coupons.yaml
  '/coupons/{id}':
    $ref: ./paths/coupons@{id}.yaml
  '/coupons/{id}/expiration':
    $ref: ./paths/coupons@{id}@expiration.yaml
  /credentials:
    $ref: ./paths/credentials.yaml
  '/credentials/{id}':
    $ref: ./paths/credentials@{id}.yaml
  '/custom-fields/{resource}':
    $ref: ./paths/custom-fields@{resource}.yaml
  '/custom-fields/{resource}/{name}':
    $ref: ./paths/custom-fields@{resource}@{name}.yaml
  /customers:
    $ref: ./paths/customers.yaml
  '/customers/{id}':
    $ref: ./paths/customers@{id}.yaml
  /customer-timeline-custom-events:
    $ref: ./paths/customer-timeline-custom-events.yaml
  '/customer-timeline-custom-events/{id}':
    $ref: ./paths/customer-timeline-custom-events@{id}.yaml
  '/customers/{id}/lead-source':
    $ref: ./paths/customers@{id}@lead-source.yaml
  '/customers/{id}/timeline':
    $ref: ./paths/customers@{id}@timeline.yaml
  '/customers/{id}/timeline/{messageId}':
    $ref: ./paths/customers@{id}@timeline@{messageId}.yaml
  '/customers/{id}/credit-balance':
    $ref: ./paths/customers@{id}@credit-balance.yaml
  '/customers/{id}/compliance-screening-report':
    $ref: ./paths/customers@{id}@compliance-screening-report.yaml
  /disputes:
    $ref: ./paths/disputes.yaml
  '/disputes/{id}':
    $ref: ./paths/disputes@{id}.yaml
  /external-identifiers:
    $ref: ./paths/external-identifiers.yaml
  /{resource}/{resourceId}/external-identifiers/{service}:
    $ref: ./paths/{resource}@{resourceId}@external-identifiers@{service}.yaml
  /external-services-settings:
    $ref: ./paths/external-services-settings.yaml
  /files:
    $ref: ./paths/files.yaml
  '/files/{id}':
    $ref: ./paths/files@{id}.yaml
  '/files/{id}/download':
    $ref: ./paths/files@{id}@download.yaml
  '/application-instances/{applicationId}':
    $ref: ./paths/application-instances@{applicationId}.yaml
  '/application-instances/{applicationId}/configuration':
    $ref: ./paths/application-instances@{applicationId}@configuration.yaml
  '/applications':
    $ref: ./paths/applications.yaml
  '/applications/{id}':
    $ref: ./paths/applications@{id}.yaml
  '/applications/{id}/instances':
    $ref: ./paths/applications@{id}@instances.yaml
  '/applications/{id}/instances/{organizationId}':
    $ref: ./paths/applications@{id}@instances@{organizationId}.yaml
  /invoices:
    $ref: ./paths/invoices.yaml
  '/invoices/{id}':
    $ref: ./paths/invoices@{id}.yaml
  '/invoices/{id}/items':
    $ref: ./paths/invoices@{id}@items.yaml
  '/invoices/{id}/items/{itemId}':
    $ref: ./paths/invoices@{id}@items@{itemId}.yaml
  '/invoices/{id}/issue':
    $ref: ./paths/invoices@{id}@issue.yaml
  '/invoices/{id}/abandon':
    $ref: ./paths/invoices@{id}@abandon.yaml
  '/invoices/{id}/void':
    $ref: ./paths/invoices@{id}@void.yaml
  '/invoices/{id}/recalculate':
    $ref: ./paths/invoices@{id}@recalculate.yaml
  '/invoices/{id}/reissue':
    $ref: ./paths/invoices@{id}@reissue.yaml
  '/invoices/{id}/transaction-allocations':
    $ref: ./paths/invoices@{id}@transaction-allocations.yaml
  '/invoices/{id}/allocate-credit-balance':
    $ref: ./paths/invoices@{id}@allocate-credit-balance.yaml
  '/invoices/{id}/transaction':
    $ref: ./paths/invoices@{id}@transaction.yaml
  '/invoices/{id}/timeline':
    $ref: ./paths/invoices@{id}@timeline.yaml
  '/invoices/{id}/timeline/{messageId}':
    $ref: ./paths/invoices@{id}@timeline@{messageId}.yaml
  /credit-memos:
    $ref: ./paths/credit-memos.yaml
  /credit-memos/{id}:
    $ref: ./paths/credit-memos@{id}.yaml
  /credit-memos/{id}/void:
    $ref: ./paths/credit-memos@{id}@void.yaml
  /credit-memos/{id}/refund:
    $ref: ./paths/credit-memos@{id}@refund.yaml
  /credit-memos/{id}/timeline:
    $ref: ./paths/credit-memos@{id}@timeline.yaml
  /credit-memos/{id}/timeline/{messageId}:
    $ref: ./paths/credit-memos@{id}@timeline@{messageId}.yaml
  /journal-accounts:
    $ref: paths/journal-accounts.yaml
  /journal-accounts/{id}:
    $ref: paths/journal-accounts@{id}.yaml
  /journal-entries:
    $ref: paths/journal-entries.yaml
  /journal-entries/{id}:
    $ref: paths/journal-entries@{id}.yaml
  /journal-records:
    $ref: paths/journal-records.yaml
  /journal-records/{id}:
    $ref: paths/journal-records@{id}.yaml
  /kyc-requests:
    $ref: ./paths/kyc-requests.yaml
  '/kyc-requests/{id}':
    $ref: ./paths/kyc-requests@{id}.yaml
  /kyc-documents:
    $ref: ./paths/kyc-documents.yaml
  '/kyc-documents/{id}':
    $ref: ./paths/kyc-documents@{id}.yaml
  '/kyc-documents/{id}/acceptance':
    $ref: ./paths/kyc-documents@{id}@acceptance.yaml
  '/kyc-documents/{id}/matches':
    $ref: ./paths/kyc-documents@{id}@matches.yaml
  '/kyc-documents/{id}/rejection':
    $ref: ./paths/kyc-documents@{id}@rejection.yaml
  '/kyc-documents/{id}/review':
    $ref: ./paths/kyc-documents@{id}@review.yaml
  '/kyc-documents/{id}/start-review':
    $ref: ./paths/kyc-documents@{id}@start-review.yaml
  '/kyc-documents/{id}/stop-review':
    $ref: ./paths/kyc-documents@{id}@stop-review.yaml
  /kyc-settings:
    $ref: ./paths/kyc-settings.yaml
  /password-tokens:
    $ref: ./paths/password-tokens.yaml
  '/password-tokens/{id}':
    $ref: ./paths/password-tokens@{id}.yaml
  '/payment-instruments':
    $ref: ./paths/payment-instruments.yaml
  '/payment-instruments/{id}':
    $ref: ./paths/payment-instruments@{id}.yaml
  '/payment-instruments/{id}/deactivation':
    $ref: ./paths/payment-instruments@{id}@deactivation.yaml
  '/payment-instruments/{id}/name-inquiry':
    $ref: ./paths/payment-instruments@{id}@name-inquiry.yaml
  /plans:
    $ref: ./paths/plans.yaml
  '/plans/{id}':
    $ref: ./paths/plans@{id}.yaml
  /products:
    $ref: ./paths/products.yaml
  '/products/{id}':
    $ref: ./paths/products@{id}.yaml
  /quotes:
    $ref: ./paths/quotes.yaml
  /quotes/{id}:
    $ref: ./paths/quotes@{id}.yaml
  /quotes/{id}/accept:
    $ref: ./paths/quotes@{id}@accept.yaml
  /quotes/{id}/cancel:
    $ref: ./paths/quotes@{id}@cancel.yaml
  /quotes/{id}/issue:
    $ref: ./paths/quotes@{id}@issue.yaml
  /quotes/{id}/recall:
    $ref: ./paths/quotes@{id}@recall.yaml
  /quotes/{id}/reject:
    $ref: ./paths/quotes@{id}@reject.yaml
  /quotes/{id}/timeline:
    $ref: ./paths/quotes@{id}@timeline.yaml
  /quotes/{id}/timeline/{messageId}:
    $ref: ./paths/quotes@{id}@timeline@{messageId}.yaml
  '/ready-to-pay':
    $ref: ./paths/ready-to-pay.yaml
  /search:
    $ref: ./paths/search.yaml
  /shipping-rates:
    $ref: ./paths/shipping-rates.yaml
  '/shipping-rates/{id}':
    $ref: ./paths/shipping-rates@{id}.yaml
  /orders:
    $ref: ./paths/orders.yaml
  /orders/{id}:
    $ref: ./paths/orders@{id}.yaml
  /orders/{id}/upcoming-invoice:
    $ref: ./paths/orders@{id}@upcoming-invoice.yaml
  /order-pauses:
    $ref: ./paths/order-pauses.yaml
  /order-pauses/{id}:
    $ref: ./paths/order-pauses@{id}.yaml
  /order-cancellations:
    $ref: ./paths/order-cancellations.yaml
  /order-cancellations/{id}:
    $ref: ./paths/order-cancellations@{id}.yaml
  /order-reactivations:
    $ref: ./paths/order-reactivations.yaml
  '/order-reactivations/{id}':
    $ref: ./paths/order-reactivations@{id}.yaml
  /subscriptions:
    $ref: ./paths/subscriptions.yaml
  '/subscriptions/{id}':
    $ref: ./paths/subscriptions@{id}.yaml
  '/subscriptions/{id}/void':
    $ref: ./paths/subscriptions@{id}@void.yaml
  '/orders/{id}/void':
    $ref: ./paths/orders@{id}@void.yaml
  '/subscriptions/{id}/change-items':
    $ref: ./paths/subscriptions@{id}@change-items.yaml
  '/orders/{id}/change-items':
    $ref: ./paths/orders@{id}@change-items.yaml
  '/subscriptions/{id}/items/{itemId}':
    $ref: ./paths/subscriptions@{id}@items@{itemId}.yaml
  '/orders/{id}/items/{itemId}':
    $ref: ./paths/orders@{id}@items@{itemId}.yaml
  '/subscriptions/{id}/interim-invoice':
    $ref: ./paths/subscriptions@{id}@interim-invoice.yaml
  '/orders/{id}/interim-invoice':
    $ref: ./paths/orders@{id}@interim-invoice.yaml
  /subscription-pauses:
    $ref: ./paths/subscription-pauses.yaml
  '/subscription-pauses/{id}':
    $ref: ./paths/subscription-pauses@{id}.yaml
  /subscription-cancellations:
    $ref: ./paths/subscription-cancellations.yaml
  '/subscription-cancellations/{id}':
    $ref: ./paths/subscription-cancellations@{id}.yaml
  /subscription-reactivations:
    $ref: ./paths/subscription-reactivations.yaml
  '/subscription-reactivations/{id}':
    $ref: ./paths/subscription-reactivations@{id}.yaml
  '/subscriptions/{id}/upcoming-invoices':
    $ref: ./paths/subscriptions@{id}@upcoming-invoices.yaml
  '/subscriptions/{id}/upcoming-invoice':
    $ref: ./paths/subscriptions@{id}@upcoming-invoice.yaml
  '/subscriptions/{id}/upcoming-invoice/issue':
    $ref: ./paths/subscriptions@{id}@upcoming-invoice@issue.yaml
  '/orders/{id}/upcoming-invoice/issue':
    $ref: ./paths/orders@{id}@upcoming-invoice@issue.yaml
  '/subscriptions/{id}/upcoming-invoices/{invoiceId}/issue':
    $ref: ./paths/subscriptions@{id}@upcoming-invoices@{invoiceId}@issue.yaml
  '/subscriptions/{id}/timeline':
    $ref: ./paths/subscriptions@{id}@timeline.yaml
  '/subscriptions/{id}/timeline/{messageId}':
    $ref: ./paths/subscriptions@{id}@timeline@{messageId}.yaml
  '/usages':
    $ref: ./paths/usages.yaml
  '/usages/{id}':
    $ref: ./paths/usages@{id}.yaml
  /tags:
    $ref: ./paths/tags.yaml
  '/tags/{tag}':
    $ref: ./paths/tags@{tag}.yaml
  '/tags/{tag}/customers':
    $ref: ./paths/tags@{tag}@customers.yaml
  '/tags/{tag}/customers/{customerId}':
    $ref: ./paths/tags@{tag}@customers@{customerId}.yaml
  '/tags/{tag}/kyc-documents':
    $ref: ./paths/tags@{tag}@kyc-documents.yaml
  '/tags/{tag}/kyc-documents/{kycDocumentId}':
    $ref: ./paths/tags@{tag}@kyc-documents@{kycDocumentId}.yaml
  '/tags/{tag}/aml-checks':
    $ref: ./paths/tags@{tag}@aml-checks.yaml
  '/tags/{tag}/aml-checks/{amlCheckId}':
    $ref: ./paths/tags@{tag}@aml-checks@{amlCheckId}.yaml
  /tokens:
    $ref: ./paths/tokens.yaml
  '/tokens/{token}':
    $ref: ./paths/tokens@{token}.yaml
  /digital-wallets/validation:
    $ref: ./paths/digital-wallets@validation.yaml
  /transactions:
    $ref: ./paths/transactions.yaml
  '/transactions/{id}':
    $ref: ./paths/transactions@{id}.yaml
  /payouts:
    $ref: ./paths/payouts.yaml
  '/transactions/{id}/query':
    $ref: ./paths/transactions@{id}@query.yaml
  '/transactions/{id}/update':
    $ref: ./paths/transactions@{id}@update.yaml
  '/transactions/{id}/refund':
    $ref: ./paths/transactions@{id}@refund.yaml
  '/transactions/{id}/timeline':
    $ref: ./paths/transactions@{id}@timeline.yaml
  '/transactions/{id}/timeline/{messageId}':
    $ref: ./paths/transactions@{id}@timeline@{messageId}.yaml
  '/fees':
    $ref: ./paths/fees.yaml
  '/fees/{id}':
    $ref: ./paths/fees@{id}.yaml
  /api-keys:
    $ref: ./paths/api-keys.yaml
  '/api-keys/{id}':
    $ref: ./paths/api-keys@{id}.yaml
  /balance-transactions:
    $ref: ./paths/balance-transactions.yaml
  '/balance-transactions/{id}':
    $ref: ./paths/balance-transactions@{id}.yaml
  /billing-portals:
    $ref: ./paths/billing-portals.yaml
  /billing-portals/{id}:
    $ref: ./paths/billing-portals@{id}.yaml
  /broadcast-messages:
    $ref: ./paths/broadcast-messages.yaml
  '/broadcast-messages/{id}':
    $ref: ./paths/broadcast-messages@{id}.yaml
  /deposit-requests:
    $ref: ./paths/deposit-requests.yaml
  /deposit-requests/{id}:
    $ref: ./paths/deposit-requests@{id}.yaml
  /cashiers:
    $ref: ./paths/cashiers.yaml
  /cashiers/{id}:
    $ref:  ./paths/cashiers@{id}.yaml
  /deposit-strategies:
    $ref: ./paths/deposit-strategies.yaml
  /deposit-strategies/{id}:
    $ref: ./paths/deposit-strategies@{id}.yaml
  /deposit-custom-property-sets:
    $ref: ./paths/deposit-custom-property-sets.yaml
  /deposit-custom-property-sets/{id}:
    $ref: ./paths/deposit-custom-property-sets@{id}.yaml
  /checkout-forms:
    $ref: ./paths/checkout-forms.yaml
  /checkout-forms/{id}:
    $ref: ./paths/checkout-forms@{id}.yaml
  /service-credentials/{type}:
    $ref: ./paths/service-credentials@{type}.yaml
  '/service-credentials/{type}/{id}':
    $ref: ./paths/service-credentials@{type}@{id}.yaml
  '/service-credentials/{type}/{id}/items':
    $ref: ./paths/service-credentials@{type}@{id}@items.yaml
  /custom-domains:
    $ref: ./paths/custom-domains.yaml
  '/custom-domains/{domain}':
    $ref: ./paths/custom-domains@{domain}.yaml
  '/email-delivery-setting-verifications/{token}':
    $ref: ./paths/email-delivery-setting-verifications@{token}.yaml
  /email-delivery-settings:
    $ref: ./paths/email-delivery-settings.yaml
  '/email-delivery-settings/{id}':
    $ref: ./paths/email-delivery-settings@{id}.yaml
  '/email-delivery-settings/{id}/resend-email-verification':
    $ref: ./paths/email-delivery-settings@{id}@resend-email-verification.yaml
  /email-messages:
    $ref: ./paths/email-messages.yaml
  '/email-messages/{id}':
    $ref: ./paths/email-messages@{id}.yaml
  /email-notifications:
    $ref: ./paths/email-notifications.yaml
  /events:
    $ref: ./paths/events.yaml
  '/events/{eventType}':
    $ref: ./paths/events@{eventType}.yaml
  '/events/{eventType}/rules':
    $ref: ./paths/events@{eventType}@rules.yaml
  '/events/{eventType}/timeline':
    $ref: ./paths/events@{eventType}@timeline.yaml
  '/events/{eventType}/timeline/{messageId}':
    $ref: ./paths/events@{eventType}@timeline@{messageId}.yaml
  '/events/{eventType}/rules/history':
    $ref: ./paths/events@{eventType}@rules@history.yaml
  '/events/{eventType}/rules/history/{version}':
    $ref: ./paths/events@{eventType}@rules@history@{version}.yaml
  '/events/{eventType}/rules/versions/{version}':
    $ref: ./paths/events@{eventType}@rules@versions@{version}.yaml
  '/events/{eventType}/rules/drafts':
    $ref: ./paths/events@{eventType}@rules@drafts.yaml
  '/events/{eventType}/rules/drafts/{id}':
    $ref: ./paths/events@{eventType}@rules@drafts@{id}.yaml
  /forgot-password:
    $ref: ./paths/forgot-password.yaml
  /gateway-accounts:
    $ref: ./paths/gateway-accounts.yaml
  '/gateway-accounts/{id}':
    $ref: ./paths/gateway-accounts@{id}.yaml
  '/gateway-accounts/{id}/close':
    $ref: ./paths/gateway-accounts@{id}@close.yaml
  '/gateway-accounts/{id}/disable':
    $ref: ./paths/gateway-accounts@{id}@disable.yaml
  '/gateway-accounts/{id}/downtime-schedules':
    $ref: ./paths/gateway-accounts@{id}@downtime-schedules.yaml
  '/gateway-accounts/{id}/downtime-schedules/{downtimeId}':
    $ref: ./paths/gateway-accounts@{id}@downtime-schedules@{downtimeId}.yaml
  '/gateway-accounts/{id}/enable':
    $ref: ./paths/gateway-accounts@{id}@enable.yaml
  '/gateway-accounts/{id}/limits':
    $ref: ./paths/gateway-accounts@{id}@limits.yaml
  '/gateway-accounts/{id}/limits/{limitId}':
    $ref: ./paths/gateway-accounts@{id}@limits@{limitId}.yaml
  '/gateway-accounts/{id}/timeline':
    $ref: ./paths/gateway-accounts@{id}@timeline.yaml
  '/gateway-accounts/{id}/timeline/{messageId}':
    $ref: ./paths/gateway-accounts@{id}@timeline@{messageId}.yaml
  '/gateway-accounts/{id}/check-credentials':
    $ref: ./paths/gateway-accounts@{id}@check-credentials.yaml
  '/gateway-accounts/{id}/financial-settings':
    $ref: ./paths/gateway-accounts@{id}@financial-settings.yaml
  /digital-wallets/onboarding/apple-pay:
    $ref: ./paths/digital-wallets@onboarding@apple-pay.yaml
  /grid-segments:
    $ref: ./paths/grid-segments.yaml
  '/grid-segments/{id}':
    $ref: ./paths/grid-segments@{id}.yaml
  /integrations:
    $ref: ./paths/integrations.yaml
  '/integrations/{label}':
    $ref: ./paths/integrations@{label}.yaml
  /lists:
    $ref: ./paths/lists.yaml
  '/lists/{id}':
    $ref: ./paths/lists@{id}.yaml
  '/lists/{id}/{version}':
    $ref: ./paths/lists@{id}@{version}.yaml
  /memberships:
    $ref: ./paths/memberships.yaml
  '/memberships/{organizationId}/{userId}':
    $ref: ./paths/memberships@{organizationId}@{userId}.yaml
  /organizations:
    $ref: ./paths/organizations.yaml
  '/organizations/{id}':
    $ref: ./paths/organizations@{id}.yaml
  /payment-cards-bank-names:
    $ref: ./paths/payment-cards-bank-names.yaml
  /payment-methods:
    $ref: ./paths/payment-methods.yaml
  /payment-methods/{apiName}:
    $ref: ./paths/payment-methods@{apiName}.yaml
  /payment-gateways-metadata:
    $ref: ./paths/payment-gateways-metadata.yaml
  /payment-gateways-metadata/{apiName}:
    $ref: ./paths/payment-gateways-metadata@{apiName}.yaml
  /payout-requests:
    $ref: ./paths/payout-requests.yaml
  '/payout-requests/{id}':
    $ref: ./paths/payout-requests@{id}.yaml
  '/payout-requests/{id}/cancel':
    $ref: ./paths/payout-requests@{id}@cancel.yaml
  '/payout-requests/{id}/split':
    $ref: ./paths/payout-requests@{id}@split.yaml
  '/payout-requests/{id}/payment-instruments':
    $ref: ./paths/payout-requests@{id}@payment-instruments.yaml
  '/payout-requests/{id}/timeline':
    $ref: ./paths/payout-requests@{id}@timeline.yaml
  '/payout-requests/{id}/timeline/{messageId}':
    $ref: ./paths/payout-requests@{id}@timeline@{messageId}.yaml
  '/payout-request-allocations':
    $ref: ./paths/payout-request-allocations.yaml
  '/payout-request-allocations/auto':
    $ref: ./paths/payout-request-allocations@auto.yaml
  '/payout-request-allocations/{id}':
    $ref: ./paths/payout-request-allocations@{id}.yaml
  '/payout-request-allocations/process':
    $ref: ./paths/payout-request-allocations@process.yaml
  '/payout-request-batches':
    $ref: ./paths/payout-request-batches.yaml
  '/payout-request-batches/{id}':
    $ref: ./paths/payout-request-batches@{id}.yaml
  '/payout-request-batches/{id}/auto-allocate':
    $ref: ./paths/payout-request-batches@{id}@auto-allocate.yaml
  '/payout-request-batches/{id}/approve':
    $ref: ./paths/payout-request-batches@{id}@approve.yaml
  '/payout-request-batches/{id}/block':
    $ref: ./paths/payout-request-batches@{id}@block.yaml
  '/payout-request-batches/{id}/payout-requests':
    $ref: ./paths/payout-request-batches@{id}@payout-requests.yaml
  '/payout-request-batches/{id}/payout-requests/remove':
    $ref: ./paths/payout-request-batches@{id}@payout-requests@remove.yaml
  '/payout-request-batches/{id}/unblock':
    $ref: ./paths/payout-request-batches@{id}@unblock.yaml
  '/payout-request-batches/preview':
    $ref: ./paths/payout-request-batches@preview.yaml
  /permissions-emulation:
    $ref: ./paths/permissions-emulation.yaml
  /previews/orders:
    $ref: ./paths/previews@orders.yaml
  /previews/rule-actions/send-email:
    $ref: ./paths/previews@rule-actions@send-email.yaml
  /previews/webhooks:
    $ref: ./paths/previews@webhooks.yaml
  /profile:
    $ref: ./paths/profile.yaml
  /profile/mfa:
    $ref: ./paths/profile@mfa.yaml
  '/roles':
    $ref: ./paths/roles.yaml
  '/roles/{id}':
    $ref: ./paths/roles@{id}.yaml
  '/send-through-attribution/{eventType}':
    $ref: ./paths/send-through-attribution@{eventType}.yaml
  /status:
    $ref: ./paths/status.yaml
  /tracking/api:
    $ref: ./paths/tracking@api.yaml
  '/tracking/api/{id}':
    $ref: ./paths/tracking@api@{id}.yaml
  /tracking/taxes:
    $ref: ./paths/tracking@taxes.yaml
  '/tracking/taxes/{id}':
    $ref: ./paths/tracking@taxes@{id}.yaml
  /tracking/lists:
    $ref: ./paths/tracking@lists.yaml
  /tracking/webhooks:
    $ref: ./paths/tracking@webhooks.yaml
  '/tracking/webhooks/{id}':
    $ref: ./paths/tracking@webhooks@{id}.yaml
  '/tracking/webhooks/{id}/resend':
    $ref: ./paths/tracking@webhooks@{id}@resend.yaml
  /users:
    $ref: ./paths/users.yaml
  '/users/{id}':
    $ref: ./paths/users@{id}.yaml
  '/users/{id}/mfa':
    $ref: ./paths/users@{id}@mfa.yaml
  /webhooks:
    $ref: ./paths/webhooks.yaml
  '/webhooks/{id}':
    $ref: ./paths/webhooks@{id}.yaml
  /websites:
    $ref: ./paths/websites.yaml
  '/websites/{id}':
    $ref: ./paths/websites@{id}.yaml
  '/experimental/customers/{customerId}/summary-metrics':
    $ref: ./paths/customers@{customerId}@summary-metrics.yaml
  /profile/dashboard:
    $ref: ./paths/profile@dashboard.yaml
  '/profile/dashboard/metrics/{metric}':
    $ref: ./paths/profile@dashboard@metrics@{metric}.yaml
  /experimental/data-exports:
    $ref: ./paths/data-exports.yaml
  '/experimental/data-exports/{id}':
    $ref: ./paths/data-exports@{id}.yaml
  /organization-exports:
    $ref: ./paths/organization-exports.yaml
  '/organization-exports/{id}':
    $ref: ./paths/organization-exports@{id}.yaml
  /experimental/histograms/aml-checks:
    $ref: ./paths/histograms@aml-checks.yaml
  /experimental/histograms/transactions:
    $ref: ./paths/histograms@transactions.yaml
  /experimental/reports/api-log-summary:
    $ref: ./paths/reports@api-log-summary.yaml
  /experimental/reports/aml-checks:
    $ref: ./paths/reports@aml-checks.yaml
  /experimental/reports/aml-checks-inherited-summary:
    $ref: ./paths/reports@aml-checks-inherited-summary.yaml
  /experimental/reports/cumulative-subscriptions:
    $ref: ./paths/reports@cumulative-subscriptions.yaml
  /experimental/reports/dashboard:
    $ref: ./paths/reports@dashboard.yaml
  /experimental/reports/dcc-markup:
    $ref: ./paths/reports@dcc-markup.yaml
  /experimental/reports/declined-transactions:
    $ref: ./paths/reports@declined-transactions.yaml
  /experimental/reports/deferred-revenue:
    $ref: ./paths/reports@deferred-revenue.yaml
  /experimental/reports/disputes:
    $ref: ./paths/reports@disputes.yaml
  /experimental/reports/events-triggered:
    $ref: ./paths/reports@events-triggered.yaml
  '/experimental/reports/events-triggered/{eventType}/rules':
    $ref: ./paths/reports@events-triggered@{eventType}@rules.yaml
  /experimental/reports/future-renewals:
    $ref: ./paths/reports@future-renewals.yaml
  /experimental/reports/journal:
    $ref: ./paths/reports@journal.yaml
  /experimental/reports/journal-summary:
    $ref: ./paths/reports@journal-summary.yaml
  /experimental/reports/kyc-acceptance-summary:
    $ref: ./paths/reports@kyc-acceptance-summary.yaml
  /experimental/reports/kyc-rejection-summary:
    $ref: ./paths/reports@kyc-rejection-summary.yaml
  /experimental/reports/kyc-request-summary:
    $ref: ./paths/reports@kyc-request-summary.yaml
  /experimental/reports/monthly-recurring-revenue:
    $ref: ./paths/reports@monthly-recurring-revenue.yaml
  /experimental/reports/annual-recurring-revenue:
    $ref: ./paths/reports@annual-recurring-revenue.yaml
  /experimental/reports/renewal-sales:
    $ref: ./paths/reports@renewal-sales.yaml
  /experimental/reports/retention-percentage:
    $ref: ./paths/reports@retention-percentage.yaml
  /experimental/reports/retention-value:
    $ref: ./paths/reports@retention-value.yaml
  /experimental/reports/revenue-waterfall:
    $ref: ./paths/reports@revenue-waterfall.yaml
  /experimental/reports/subscription-cancellation:
    $ref: ./paths/reports@subscription-cancellation.yaml
  /experimental/reports/subscription-renewal:
    $ref: ./paths/reports@subscription-renewal.yaml
  /experimental/reports/tax:
    $ref: ./paths/reports@tax.yaml
  /experimental/reports/time-series-transaction:
    $ref: ./paths/reports@time-series-transaction.yaml
  /experimental/reports/transactions-time-dispute:
    $ref: ./paths/reports@transactions-time-dispute.yaml
  /experimental/reports/transactions:
    $ref: ./paths/reports@transactions.yaml
  '/experimental/subscriptions/{subscriptionId}/summary-metrics':
    $ref: ./paths/subscriptions@{subscriptionId}@summary-metrics.yaml
  '/storefront/account':
    $ref: ./paths/storefront/account.yaml
  '/storefront/account/forgot-password':
    $ref: paths/storefront/account@forgot-password.yaml
  '/storefront/account/password':
    $ref: paths/storefront/account@password.yaml
  '/storefront/account/resend-verification':
    $ref: paths/storefront/account@resend-verification.yaml
  '/storefront/account/reset-password/{token}':
    $ref: paths/storefront/account@reset-password@{token}.yaml
  '/storefront/account/verification/{token}':
    $ref: paths/storefront/account@verification@{token}.yaml
  '/storefront/billing-portals/{slug}':
    $ref: paths/storefront/billing-portals@{slug}.yaml
  '/storefront/deposit-strategies/{id}':
    $ref: paths/storefront/deposit-strategies@{id}.yaml
  '/storefront/deposit-requests/{id}':
    $ref: paths/storefront/deposit-requests@{id}.yaml
  '/storefront/cashiers/{id}':
    $ref: paths/storefront/cashiers@{id}.yaml
  '/storefront/cashiers/{id}/cancel-payout-requests':
    $ref: paths/storefront/cashiers@{id}payout-request-cancellation.yaml
  '/storefront/deposit':
    $ref: paths/storefront/deposit.yaml
  '/storefront/checkout-forms/{id}':
    $ref: paths/storefront/checkout-forms@{id}.yaml
  '/storefront/custom-fields/{resource}':
    $ref: paths/storefront/custom-fields@{resource}.yaml
  '/storefront/invoices':
    $ref: paths/storefront/invoices.yaml
  '/storefront/invoices/{id}':
    $ref: paths/storefront/invoices@{id}.yaml
  '/storefront/orders/{id}/upcoming-invoice':
    $ref: paths/storefront/orders@{id}@upcoming-invoice.yaml
  '/storefront/kyc-documents':
    $ref: paths/storefront/kyc-documents.yaml
  '/storefront/kyc-documents/{id}':
    $ref: paths/storefront/kyc-documents@{id}.yaml
  '/storefront/kyc-requests/{id}':
    $ref: paths/storefront/kyc-requests@{id}.yaml
  '/storefront/kyc-liveness-sessions':
    $ref: paths/storefront/kyc-liveness-sessions.yaml
  '/storefront/kyc-liveness-sessions/{id}':
    $ref: paths/storefront/kyc-liveness-sessions@{id}.yaml
  '/storefront/kyc-liveness-sessions/{id}/finish':
    $ref: paths/storefront/kyc-liveness-sessions@{id}@finish.yaml
  '/storefront/login':
    $ref: paths/storefront/login.yaml
  '/storefront/logout':
    $ref: paths/storefront/logout.yaml
  '/storefront/orders':
    $ref: paths/storefront/orders.yaml
  '/storefront/orders/{id}':
    $ref: paths/storefront/orders@{id}.yaml
  '/storefront/orders/{id}/cancellation':
    $ref: paths/storefront/orders@{id}@cancellation.yaml
  '/storefront/orders/{id}/pause':
    $ref: paths/storefront/orders@{id}@pause.yaml
  '/storefront/subscriptions/{id}/change-items':
    $ref: paths/storefront/subscriptions@{id}@change-items.yaml
  '/storefront/subscription-reactivations':
    $ref: paths/storefront/subscription-reactivations.yaml
  '/storefront/payment':
    $ref: paths/storefront/payment.yaml
  '/storefront/payment-instruments':
    $ref: paths/storefront/payment-instruments.yaml
  '/storefront/payment-instruments/{id}':
    $ref: paths/storefront/payment-instruments@{id}.yaml
  '/storefront/payment-instruments/{id}/deactivation':
    $ref: paths/storefront/payment-instruments@{id}@deactivation.yaml
  '/storefront/payment-instruments/{id}/setup':
    $ref: paths/storefront/payment-instruments@{id}@setup.yaml
  '/storefront/payout-requests':
    $ref: ./paths/storefront/payout-requests.yaml
  '/storefront/payout-requests/{id}':
    $ref: paths/storefront/payout-requests@{id}.yaml
  '/storefront/plans':
    $ref: paths/storefront/plans.yaml
  '/storefront/plans/{id}':
    $ref: paths/storefront/plans@{id}.yaml
  '/storefront/products':
    $ref: paths/storefront/products.yaml
  '/storefront/products/{id}':
    $ref: paths/storefront/products@{id}.yaml
  '/storefront/purchase':
    $ref: paths/storefront/purchase.yaml
  '/storefront/preview-purchase':
    $ref: paths/storefront/preview-purchase.yaml
  '/storefront/quotes/{id}':
    $ref: paths/storefront/quotes@{id}.yaml
  '/storefront/quotes/{id}/accept':
    $ref: paths/storefront/quotes@{id}@accept.yaml
  '/storefront/quotes/{id}/reject':
    $ref: paths/storefront/quotes@{id}@reject.yaml
  '/storefront/ready-to-pay':
    $ref: paths/storefront/ready-to-pay.yaml
  '/storefront/ready-to-payout':
    $ref: paths/storefront/ready-to-payout.yaml
  '/storefront/register':
    $ref: paths/storefront/register.yaml
  '/storefront/subscriptions':
    $ref: paths/storefront/subscriptions.yaml
  '/storefront/transactions':
    $ref: paths/storefront/transactions.yaml
  '/storefront/transactions/{id}':
    $ref: paths/storefront/transactions@{id}.yaml
  '/storefront/transactions/{id}/dcc':
    $ref: paths/storefront/transactions@{id}@dcc.yaml
  '/storefront/transactions/{id}/{token}/continue':
    $ref: paths/storefront/transactions@{id}@{token}@continue.yaml
  '/storefront/transactions/{id}/{token}/bypass':
    $ref: paths/storefront/transactions@{id}@{token}@bypass.yaml
  '/storefront/websites/{id}':
    $ref: paths/storefront/websites@{id}.yaml
  '/risk-score-rules':
    $ref: paths/risk-score-rules.yaml
  '/risk-score-rules/blocklists':
    $ref: paths/risk-score-rules@blocklists.yaml
  '/allowlists':
    $ref: paths/allowlists.yaml
  '/allowlists/{id}':
    $ref: paths/allowlists@{id}.yaml
  '/tags-rules':
    $ref: paths/tags-rules.yaml
  '/tags-rules/{id}':
    $ref: paths/tags-rules@{id}.yaml

webhooks:
  application-instance-disabled:
    post:
      $ref: ./webhooks/application-instance-disabled.yaml
  application-instance-enabled:
    post:
      $ref: ./webhooks/application-instance-enabled.yaml
  aml-list-possibly-matched:
    post:
      $ref: ./webhooks/aml-list-possibly-matched.yaml
  balance-transaction-settled:
    post:
      $ref: ./webhooks/balance-transaction-settled.yaml
  coupon-application-removed:
    post:
      $ref: ./webhooks/coupon-application-removed.yaml
  coupon-applied:
    post:
      $ref: ./webhooks/coupon-applied.yaml
  coupon-expiration-modified:
    post:
      $ref: ./webhooks/coupon-expiration-modified.yaml
  coupon-expired:
    post:
      $ref: ./webhooks/coupon-expired.yaml
  coupon-issued:
    post:
      $ref: ./webhooks/coupon-issued.yaml
  coupon-modified:
    post:
      $ref: ./webhooks/coupon-modified.yaml
  coupon-redeemed:
    post:
      $ref: ./webhooks/coupon-redeemed.yaml
  coupon-redemption-canceled:
    post:
      $ref: ./webhooks/coupon-redemption-canceled.yaml
  credit-memo-applied:
    post:
      $ref: ./webhooks/credit-memo-applied.yaml
  credit-memo-created:
    post:
      $ref: ./webhooks/credit-memo-created.yaml
  credit-memo-modified:
    post:
      $ref: ./webhooks/credit-memo-modified.yaml
  credit-memo-partially-applied:
    post:
      $ref: ./webhooks/credit-memo-partially-applied.yaml
  credit-memo-voided:
    post:
      $ref: ./webhooks/credit-memo-voided.yaml
  customer-created:
    post:
      $ref: ./webhooks/customer-created.yaml
  customer-merged:
    post:
      $ref: ./webhooks/customer-merged.yaml
  customer-one-time-password-requested:
    post:
      $ref: ./webhooks/customer-one-time-password-requested.yaml
  customer-redirected-offsite:
    post:
      $ref: ./webhooks/customer-redirected-offsite.yaml
  customer-returned:
    post:
      $ref: ./webhooks/customer-returned.yaml
  customer-tax-number-validated:
    post:
      $ref: ./webhooks/customer-tax-number-validated.yaml
  customer-updated:
    post:
      $ref: ./webhooks/customer-updated.yaml
  dispute-created:
    post:
      $ref: ./webhooks/dispute-created.yaml
  dispute-modified:
    post:
      $ref: ./webhooks/dispute-modified.yaml
  experian-check-performed:
    post:
      $ref: ./webhooks/experian-check-performed.yaml
  hard-usage-limit-reached:
    post:
      $ref: ./webhooks/hard-usage-limit-reached.yaml
  orders-experimental-hard-usage-limit-reached:
    post:
      $ref: ./webhooks/orders-experimental-hard-usage-limit-reached.yaml
  invoice-tax-calculation-failed:
    post:
      $ref: ./webhooks/invoice-tax-calculation-failed.yaml
  gateway-account-downtime-ended:
    post:
      $ref: ./webhooks/gateway-account-downtime-ended.yaml
  gateway-account-downtime-started:
    post:
      $ref: ./webhooks/gateway-account-downtime-started.yaml
  gateway-account-limit-reached:
    post:
      $ref: ./webhooks/gateway-account-limit-reached.yaml
  gateway-account-onboarding-completed:
    post:
      $ref: ./webhooks/gateway-account-onboarding-completed.yaml
  gateway-account-onboarding-failed:
    post:
      $ref: ./webhooks/gateway-account-onboarding-failed.yaml
  gateway-account-requested:
    post:
      $ref: ./webhooks/gateway-account-requested.yaml
  invoice-abandoned:
    post:
      $ref: ./webhooks/invoice-abandoned.yaml
  invoice-created:
    post:
      $ref: ./webhooks/invoice-created.yaml
  invoice-issued:
    post:
      $ref: ./webhooks/invoice-issued.yaml
  invoice-modified:
    post:
      $ref: ./webhooks/invoice-modified.yaml
  invoice-paid:
    post:
      $ref: ./webhooks/invoice-paid.yaml
  invoice-partially-paid:
    post:
      $ref: ./webhooks/invoice-partially-paid.yaml
  invoice-refunded:
    post:
      $ref: ./webhooks/invoice-refunded.yaml
  invoice-partially-refunded:
    post:
      $ref: ./webhooks/invoice-partially-refunded.yaml
  invoice-past-due:
    post:
      $ref: ./webhooks/invoice-past-due.yaml
  invoice-past-due-reminder:
    post:
      $ref: ./webhooks/invoice-past-due-reminder.yaml
  invoice-reissued:
    post:
      $ref: ./webhooks/invoice-reissued.yaml
  invoice-voided:
    post:
      $ref: ./webhooks/invoice-voided.yaml
  kyc-document-accepted:
    post:
      $ref: ./webhooks/kyc-document-accepted.yaml
  kyc-document-created:
    post:
      $ref: ./webhooks/kyc-document-created.yaml
  kyc-document-modified:
    post:
      $ref: ./webhooks/kyc-document-modified.yaml
  kyc-document-rejected:
    post:
      $ref: ./webhooks/kyc-document-rejected.yaml
  kyc-document-reviewed:
    post:
      $ref: ./webhooks/kyc-document-reviewed.yaml
  kyc-document-archived:
    post:
      $ref: ./webhooks/kyc-document-archived.yaml
  kyc-request-attempted:
    post:
      $ref: ./webhooks/kyc-request-attempted.yaml
  kyc-request-failed:
    post:
      $ref: ./webhooks/kyc-request-failed.yaml
  kyc-request-fulfilled:
    post:
      $ref: ./webhooks/kyc-request-fulfilled.yaml
  kyc-request-partially-fulfilled:
    post:
      $ref: ./webhooks/kyc-request-partially-fulfilled.yaml
  lead-source-changed:
    post:
      $ref: ./webhooks/lead-source-changed.yaml
  offsite-payment-completed:
    post:
      $ref: ./webhooks/offsite-payment-completed.yaml
  order-abandon-reminder:
    post:
      $ref: ./webhooks/order-abandon-reminder.yaml
  orders-experimental-order-abandon-reminder:
    post:
      $ref: ./webhooks/orders-experimental-order-abandon-reminder.yaml
  order-abandoned:
    post:
      $ref: ./webhooks/order-abandoned.yaml
  orders-experimental-order-abandoned:
    post:
      $ref: ./webhooks/orders-experimental-order-abandoned.yaml
  order-completed:
    post:
      $ref: ./webhooks/order-completed.yaml
  orders-experimental-order-completed:
    post:
      $ref: ./webhooks/orders-experimental-order-completed.yaml
  organization-tax-number-validated:
    post:
      $ref: ./webhooks/organization-tax-number-validated.yaml
  payment-card-created:
    post:
      $ref: ./webhooks/payment-card-created.yaml
  payment-card-expiration-reminder:
    post:
      $ref: ./webhooks/payment-card-expiration-reminder.yaml
  payment-card-expired:
    post:
      $ref: ./webhooks/payment-card-expired.yaml
  payment-instrument-modified:
    post:
      $ref: ./webhooks/payment-instrument-modified.yaml
  payout-request-canceled:
    post:
      $ref: ./webhooks/payout-request-canceled.yaml
  payout-request-created:
    post:
      $ref: ./webhooks/payout-request-created.yaml
  payout-request-fulfilled:
    post:
      $ref: ./webhooks/payout-request-fulfilled.yaml
  payout-request-modified:
    post:
      $ref: ./webhooks/payout-request-modified.yaml
  quote-accepted:
    post:
      $ref: ./webhooks/quote-accepted.yaml
  quote-canceled:
    post:
      $ref: ./webhooks/quote-canceled.yaml
  quote-created:
    post:
      $ref: ./webhooks/quote-created.yaml
  quote-expired:
    post:
      $ref: ./webhooks/quote-expired.yaml
  quote-issued:
    post:
      $ref: ./webhooks/quote-issued.yaml
  quote-recalled:
    post:
      $ref: ./webhooks/quote-recalled.yaml
  quote-rejected:
    post:
      $ref: ./webhooks/quote-rejected.yaml
  quote-updated:
    post:
      $ref: ./webhooks/quote-updated.yaml
  ready-to-pay-requested:
    post:
      $ref: ./webhooks/ready-to-pay-requested.yaml
  renewal-invoice-issued:
    post:
      $ref: ./webhooks/renewal-invoice-issued.yaml
  orders-experimental-renewal-invoice-issued:
    post:
      $ref: ./webhooks/orders-experimental-renewal-invoice-issued.yaml
  renewal-invoice-payment-canceled:
    post:
      $ref: ./webhooks/renewal-invoice-payment-canceled.yaml
  renewal-invoice-payment-declined:
    post:
      $ref: ./webhooks/renewal-invoice-payment-declined.yaml
  risk-score-changed:
    post:
      $ref: ./webhooks/risk-score-changed.yaml
  soft-usage-limit-reached:
    post:
      $ref: ./webhooks/soft-usage-limit-reached.yaml
  orders-experimental-soft-usage-limit-reached:
    post:
      $ref: ./webhooks/orders-experimental-soft-usage-limit-reached.yaml
  subscription-activated:
    post:
      $ref: ./webhooks/subscription-activated.yaml
  orders-experimental-subscription-activated:
    post:
      $ref: ./webhooks/orders-experimental-subscription-activated.yaml
  subscription-canceled:
    post:
      $ref: ./webhooks/subscription-canceled.yaml
  orders-experimental-subscription-canceled:
    post:
      $ref: ./webhooks/orders-experimental-subscription-canceled.yaml
  subscription-churned:
    post:
      $ref: ./webhooks/subscription-churned.yaml
  orders-experimental-subscription-churned:
    post:
      $ref: ./webhooks/orders-experimental-subscription-churned.yaml
  subscription-created:
    post:
      $ref: ./webhooks/subscription-created.yaml
  orders-experimental-subscription-created:
    post:
      $ref: ./webhooks/orders-experimental-subscription-created.yaml
  subscription-downgraded:
    post:
      $ref: ./webhooks/subscription-downgraded.yaml
  orders-experimental-subscription-downgraded:
    post:
      $ref: ./webhooks/orders-experimental-subscription-downgraded.yaml
  subscription-items-changed:
    post:
      $ref: ./webhooks/subscription-items-changed.yaml
  orders-experimental-subscription-items-changed:
    post:
      $ref: ./webhooks/orders-experimental-subscription-items-changed.yaml
  subscription-modified:
    post:
      $ref: ./webhooks/subscription-modified.yaml
  orders-experimental-subscription-modified:
    post:
      $ref: ./webhooks/orders-experimental-subscription-modified.yaml
  subscription-quantity-filled-limit-reached:
    post:
      $ref: ./webhooks/subscription-quantity-filled-limit-reached.yaml
  orders-experimental-subscription-quantity-filled-limit-reached:
    post:
      $ref: ./webhooks/orders-experimental-subscription-quantity-filled-limit-reached.yaml
  subscription-reactivated:
    post:
      $ref: ./webhooks/subscription-reactivated.yaml
  orders-experimental-subscription-reactivated:
    post:
      $ref: ./webhooks/orders-experimental-subscription-reactivated.yaml
  subscription-renewal-reminder:
    post:
      $ref: ./webhooks/subscription-renewal-reminder.yaml
  orders-experimental-subscription-renewal-reminder:
    post:
      $ref: ./webhooks/orders-experimental-subscription-renewal-reminder.yaml
  subscription-renewed:
    post:
      $ref: ./webhooks/subscription-renewed.yaml
  orders-experimental-subscription-renewed:
    post:
      $ref: ./webhooks/orders-experimental-subscription-renewed.yaml
  subscription-trial-converted:
    post:
      $ref: ./webhooks/subscription-trial-converted.yaml
  orders-experimental-subscription-trial-converted:
    post:
      $ref: ./webhooks/orders-experimental-subscription-trial-converted.yaml
  subscription-trial-end-reminder:
    post:
      $ref: ./webhooks/subscription-trial-end-reminder.yaml
  orders-experimental-subscription-trial-end-reminder:
    post:
      $ref: ./webhooks/orders-experimental-subscription-trial-end-reminder.yaml
  subscription-trial-ended:
    post:
      $ref: ./webhooks/subscription-trial-ended.yaml
  orders-experimental-subscription-trial-ended:
    post:
      $ref: ./webhooks/orders-experimental-subscription-trial-ended.yaml
  subscription-upgraded:
    post:
      $ref: ./webhooks/subscription-upgraded.yaml
  orders-experimental-subscription-upgraded:
    post:
      $ref: ./webhooks/orders-experimental-subscription-upgraded.yaml
  subscription-paused:
    post:
      $ref: ./webhooks/subscription-paused.yaml
  orders-experimental-subscription-paused:
    post:
      $ref: ./webhooks/orders-experimental-subscription-paused.yaml
  subscription-pause-created:
    post:
      $ref: ./webhooks/subscription-pause-created.yaml
  orders-experimental-subscription-pause-created:
    post:
      $ref: ./webhooks/orders-experimental-subscription-pause-created.yaml
  subscription-pause-modified:
    post:
      $ref: ./webhooks/subscription-pause-modified.yaml
  orders-experimental-subscription-pause-modified:
    post:
      $ref: ./webhooks/orders-experimental-subscription-pause-modified.yaml
  subscription-pause-revoked:
    post:
      $ref: ./webhooks/subscription-pause-revoked.yaml
  orders-experimental-subscription-pause-revoked:
    post:
      $ref: ./webhooks/orders-experimental-subscription-pause-revoked.yaml
  subscription-resumed:
    post:
      $ref: ./webhooks/subscription-resumed.yaml
  orders-experimental-subscription-resumed:
    post:
      $ref: ./webhooks/orders-experimental-subscription-resumed.yaml
  transaction-amount-discrepancy-found:
    post:
      $ref: ./webhooks/transaction-amount-discrepancy-found.yaml
  transaction-declined:
    post:
      $ref: ./webhooks/transaction-declined.yaml
  transaction-discrepancy-found:
    post:
      $ref: ./webhooks/transaction-discrepancy-found.yaml
  transaction-process-requested:
    post:
      $ref: ./webhooks/transaction-process-requested.yaml
  transaction-processed:
    post:
      $ref: ./webhooks/transaction-processed.yaml
  transaction-reconciled:
    post:
      $ref: ./webhooks/transaction-reconciled.yaml
  transaction-partially-refunded:
    post:
      $ref: ./webhooks/transaction-partially-refunded.yaml
  transaction-refunded:
    post:
      $ref: ./webhooks/transaction-refunded.yaml
  transaction-voided:
    post:
      $ref: ./webhooks/transaction-voided.yaml
  transaction-timeout-resolved:
    post:
      $ref: ./webhooks/transaction-timeout-resolved.yaml
  trial-usage-limit-reached:
    post:
      $ref: ./webhooks/trial-usage-limit-reached.yaml
  orders-experimental-trial-usage-limit-reached:
    post:
      $ref: ./webhooks/orders-experimental-trial-usage-limit-reached.yaml
  waiting-gateway-transaction-completed:
    post:
      $ref: ./webhooks/waiting-gateway-transaction-completed.yaml
  data-export-completed:
    post:
      $ref: ./webhooks/data-export-completed.yaml
  order-delinquency-reached:
    post:
      $ref: ./webhooks/order-delinquency-reached.yaml
  orders-experimental-order-delinquency-reached:
    post:
      $ref: ./webhooks/orders-experimental-order-delinquency-reached.yaml
  autodeposit-lookup-performed:
    post:
      $ref: ./webhooks/autodeposit-lookup-performed.yaml