Update references and readme

README.md

@@ -5,9 +5,14 @@
 
 TBD: Add Redocly validation status badge.
 
-## Links
+## View API docs
 
-- [Rebilly API docs](https://www.rebilly.com/catalog/all)
+To view the full Rebilly API reference documentation, go to [https://www.rebilly.com/catalog/all/](https://www.rebilly.com/catalog/all/).
+
+The full Rebilly API reference documentation has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, [contact Rebilly](https://www.rebilly.com/support/) for guidance and feedback on the best API operations to use for the task.
+
+To integrate Rebilly, and learn about related resources and concepts,
+see [Get started](https://www.rebilly.com/docs/dev-docs/get-started/).
 
 ## Contributing
 
@@ -26,7 +31,7 @@ If you use VS Code, use the [Redocly VS Code extension](https://marketplace.visu
 
 #### Preview
 
-This process describes how to start a development server docs preview for the Rebilly API docs. 
+This process describes how to start a development server docs preview for the Rebilly API docs.
 Changes made to the API specification while the development server is running are immediately displayed in the docs preview.
 
 Rebilly uses [Redocly](https://redocly.com/) to generate, manage, and preview API docs.
@@ -39,7 +44,7 @@ Rebilly uses [Redocly](https://redocly.com/) to generate, manage, and preview AP
 1. In the **Personal API keys** section, click **Add API key**.
 1. Enter an API key name, then click **Save**.
 1. Copy the API key.
-1. In a terminal, execute the following command: `npx @redocly/cli login`. 
+1. In a terminal, execute the following command: `npx @redocly/cli login`.
 1. When prompted, paste your API key.
 1. Execute one of the following commands to start a development server docs preview:
     - Core API docs: `npx @redocly/cli preview-docs core@latest`

openapi/components/parameters/collectionExpand.yaml

@@ -5,6 +5,6 @@ description: |-
   property of the response. This field accepts a comma-separated list of objects.
 
   For more information, see
-  [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
+  [Expand to include embedded objects](https://www.rebilly.com/catalog/all/#section/Expand-to-include-embedded-objects).
 schema:
   type: string

openapi/components/parameters/collectionFilter.yaml

@@ -5,6 +5,6 @@ description: |-
   a special format. Use `,` for multiple allowed values.  Use `;` for multiple fields.
 
   For more information, see
-  [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+  [Using filter with collections](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections).
 schema:
   type: string

openapi/components/parameters/subscriptionExpand.yaml

@@ -17,6 +17,6 @@ description: |-
     - `upcomingInvoice`
     - `paymentInstrument`
 
-  For more information, see [Expand to include embedded objects](../../overview/#section/Expand-to-include-embedded-objects).
+  For more information, see [Expand to include embedded objects](https://www.rebilly.com/catalog/all/#section/Expand-to-include-embedded-objects).
 schema:
   type: string

openapi/components/requestBodies/PostDepositRequest.yaml

@@ -27,7 +27,7 @@ properties:
           multipleOf: 1
           maximum: 10000
       ```
-      For more information, see [Create a deposit strategy](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositStrategy).
+      For more information, see [Create a deposit strategy](https://www.rebilly.com/catalog/all/Deposits/PostDepositStrategy).
     type:
       - 'string'
       - 'null'
@@ -43,7 +43,7 @@ properties:
       List of available deposit amounts.
 
       If `amounts` is not specified when a deposit request is created, amounts are determined from the chosen strategy.
-      For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request).
+      For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest#!t=request&path=strategyId).
     items:
       type: number
       format: double
@@ -80,7 +80,7 @@ properties:
       Custom amount restrictions.
       If this value is `null`,  custom amounts are prohibited.
       If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy.
-      For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request).
+      For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest#!t=request&path=strategyId).
     required:
       - minimum
       - multipleOf

openapi/components/schemas/ApplicationInstance.yaml

@@ -13,7 +13,7 @@ properties:
   isConfigured:
     description: |-
       Determines if the configuration of the application instance is complete.
-      Configuration is completed using the [PutApplicationInstanceConfiguration](https://all-rebilly.redoc.ly/tag/Application-users/operation/PutApplicationInstanceConfiguration) operation.
+      Configuration is completed using the [Upsert an application instance configuration](https://www.rebilly.com/catalog/all/Application-users/PutApplicationInstanceConfiguration) operation.
     type: boolean
     readOnly: true
   settings:

openapi/components/schemas/Bind.yaml

@@ -30,7 +30,7 @@ properties:
       This field requires a special format. Use `,` for multiple allowed values.
       Use `;` for multiple fields.
 
-      For more information, see [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+      For more information, see [Using filter with collections](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections).
     type: string
   actions:
     description: Actions that execute when an event occurs.

openapi/components/schemas/BroadcastMessage.yaml

@@ -73,9 +73,9 @@ properties:
                   > **Important:** This value must be a verified email address.
 
                   To verify an email address:
-                    1. [Create an email delivery setting](../../Email-delivery-settings/operation/PostEmailDeliverySetting).
-                      In the response, you receive the email and a token.
-                    1. [Verify the email delivery](../../Email-delivery-settings/operation/PutEmailDeliverySettingsVerification) by passing the token as the path parameter.
+                    1. [Create an email delivery setting](https://www.rebilly.com/catalog/all/Email-delivery-settings/PostEmailDeliverySetting/).
+                    In the response, you receive the email and a token.
+                    1. [Verify the email delivery](https://www.rebilly.com/catalog/all/Email-delivery-settings/PutEmailDeliverySettingsVerification/) by passing the token as the path parameter.
                 maxLength: 254
                 example: [email protected]
               subject:

openapi/components/schemas/DepositRequest.yaml

@@ -47,7 +47,7 @@ properties:
       List of available deposit amounts.
 
       If `amounts` is not specified when a deposit is created, amounts are determined from the chosen strategy.
-      For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request).
+      For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest/#!t=request&path=strategyId).
     items:
       type: number
       format: double
@@ -60,7 +60,7 @@ properties:
       Custom amount restrictions.
       If this value is `null`,  custom amounts are prohibited.
       If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy.
-      For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request).
+      For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest/#!t=request&path=strategyId).
     required:
       - minimum
       - multipleOf

openapi/components/schemas/DepositStrategy.yaml

@@ -53,7 +53,7 @@ properties:
         description: |-
           List of incremental amounts that are displayed to customer.
 
-          For more information, see the [`calculator` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositStrategy#!path=amounts/calculator&t=request).
+          For more information, see the [`calculator` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositStrategy#!t=request&path=amounts/calculator).
         items:
           type: number
           format: double
@@ -63,7 +63,7 @@ properties:
         default: false
         description: |-
           Specifies if the base amount must be adjusted based on the last deposit.
-          If this value is `true`, the `baseAmount` is changed to the last successful deposit amount made using [Create a deposit request](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest).
+          If this value is `true`, the `baseAmount` is changed to the last successful deposit amount made using [Create a deposit request](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest).
 
           If the customer has no successful deposits, `baseAmount` is not adjusted.
   customAmount:
@@ -74,7 +74,7 @@ properties:
       Custom amount restrictions.
       If this value is `null`,  custom amounts are prohibited.
       If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy.
-      For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request).
+      For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest#!t=request&path=strategyId).
     required:
       - minimum
       - multipleOf

openapi/components/schemas/FlexiblePlan.yaml

@@ -3,7 +3,7 @@ allOf:
     description: |-
       Customize an existing plan for the current order.
 
-      To create a new plan, see [Create a plan](https://all-rebilly.redoc.ly/tag/Plans/operation/PostPlan).
+      To create a new plan, see [Create a plan](https://www.rebilly.com/catalog/all/Plans/PostPlan).
     required:
       - id
     properties:

openapi/components/schemas/GatewayAccount.yaml

@@ -321,7 +321,7 @@ properties:
       If a transaction exceeds this value, the gateway account is not used.
 
       For more information see,
-      [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+      [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections).
     type:
       - 'string'
       - 'null'
@@ -376,8 +376,7 @@ properties:
   readyToPayoutInstruction:
     type: string
     default: none
-    description: |-
-      Defines the mode of gateway payout behaviour for the [Ready to payout](https://all-rebilly.redoc.ly/tag/Purchases/operation/StorefrontPostReadyToPayout) operation.
+    description: Defines the mode of gateway payout behaviour for the [Ready to payout](https://www.rebilly.com/catalog/all/Purchases/StorefrontPostReadyToPayout) operation.
     enum:
       - all
       - covered-payout

openapi/components/schemas/GlobalWebhook.yaml

@@ -87,7 +87,7 @@ properties:
       Use `;` for multiple fields.
 
       For more information,
-      see [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+      see [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections).
     type:
       - 'string'
       - 'null'

openapi/components/schemas/OneTimeSale.yaml

@@ -118,7 +118,7 @@ properties:
     description: |-
       Date and time when the pending order is automatically abandoned.
       If this value is not passed during order creation,
-      a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value.
+      a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value.
     format: date-time
   couponIds:
     type:

openapi/components/schemas/OriginalPlan.yaml

@@ -2,7 +2,7 @@ type: object
 description: |-
   Use an existing plan without changes for the current order.
 
-  To create a new plan, see [Create a plan](https://all-rebilly.redoc.ly/tag/Plans/operation/PostPlan).
+  To create a new plan, see [Create a plan](https://www.rebilly.com/catalog/all/Plans/PostPlan).
 required:
   - id
 properties:

openapi/components/schemas/ReadyToPayMethodFilters.yaml

@@ -2,6 +2,6 @@ type: array
 description: |-
   For the method to be applicable, one or more of the following filters must match.
   If no filters are sent, no restrictions are applied.
-  For more information, see [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+  For more information, see [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections).
 items:
   type: string

openapi/components/schemas/ReadyToPayoutMethodFilters.yaml

@@ -2,6 +2,6 @@ type: array
 description: |-
   For the method to be applicable, one or more of the following filters must match.
   If no filters are sent, no restrictions are applied.
-  For more information, see [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+  For more information, see [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections).
 items:
   type: string

openapi/components/schemas/RebillyShipping.yaml

@@ -19,4 +19,4 @@ properties:
     type: number
     format: double
     readOnly: true
-    description: Shipping amount which is calculated from [Shipping rates](https://all-rebilly.redoc.ly/tag/Shipping-rates).
+    description: Shipping amount which is calculated from [Shipping rates](https://www.rebilly.com/catalog/all/Shipping-rates).

openapi/components/schemas/ResourceCustomFields.yaml

@@ -1,6 +1,6 @@
 description: |-
   Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
-  For more information, see [Custom fields](https://all-rebilly.redoc.ly/tag/Custom-fields).
+  For more information, see [Custom fields](https://www.rebilly.com/catalog/all/Custom-fields).
 type: object
 default: {}
 example: {"foo": "bar"}

openapi/components/schemas/RulesEmailNotification.yaml

@@ -61,9 +61,9 @@ properties:
             > **Important:** This value must be a verified email address.
 
             To verify an email address:
-              1. [Create an email delivery setting](../../Email-delivery-settings/operation/PostEmailDeliverySetting).
+              1. [Create an email delivery setting](https://www.rebilly.com/catalog/all/Email-delivery-settings/PostEmailDeliverySetting/).
                 In the response, you receive the email and a token.
-              1. [Verify the email delivery](../../Email-delivery-settings/operation/PutEmailDeliverySettingsVerification) by passing the token as the path parameter.
+              1. [Verify the email delivery](https://www.rebilly.com/catalog/all/Email-delivery-settings/PutEmailDeliverySettingsVerification/) by passing the token as the path parameter.
 
             Template placeholders are permitted.
             If a placeholder does not resolve to a verified `from` address,

openapi/components/schemas/StorefrontOneTimeSale.yaml

@@ -86,7 +86,7 @@ properties:
     description: |-
       Date and time when the pending order is automatically abandoned.
       If this value is not passed during order creation,
-      a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value.
+      a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value.
     format: date-time
   couponIds:
     type:

openapi/components/schemas/StorefrontSubscription.yaml

@@ -86,7 +86,7 @@ properties:
     description: |-
       Date and time when the pending order is automatically abandoned.
       If this value is not passed during order creation,
-      a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value.
+      a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value.
     format: date-time
   couponIds:
     type:

openapi/components/schemas/Subscription.yaml

@@ -331,7 +331,7 @@ properties:
     description: |-
       Date and time when the pending order is automatically abandoned.
       If this value is not passed during order creation,
-      a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value.
+      a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value.
     format: date-time
   delinquencyPeriod:
     type:

openapi/components/schemas/VaultedInstrument.yaml

@@ -7,7 +7,7 @@ properties:
   method:
     description: |-
       Payment method supported vault.
-      For more information, see [Payment instrument](https://all-rebilly.redoc.ly/tag/Payment-instruments).
+      For more information, see [Payment instrument](https://www.rebilly.com/catalog/all/Payment-instruments).
     type: string
     enum:
       - payment-card