API Overview

Recurring Billing Developer Guide
- Recent Revisions to This Document

Introduction to Recurring Billing
- Account Validation (Pre-Authorization)

Plans
- Plan Statuses
- Assigning a Plan Code
- Creating a Plan
- Retrieving a List of Plans
- Retrieving a Plan
- Retrieving a Plan Code
- Amending a Plan
- Activating a Plan
- Deactivating a Plan
- Deleting a Plan

Subscriptions
- Subscription Prerequisites
- Subscription Statuses
- Zero-Amount Authorizations
- Assigning a Subscription Code
- Subscription ID
- Overriding a Plan
- Creating a Subscription with an Existing Plan
- Creating a Subscription with Plan Overrides
- Creating a Fully Customized Subscription with a One-Time Plan
- Creating a Follow-on Subscription from an Existing Transaction
- Retrieving the Details of a Follow-on Subscription Based on an Existing Transaction
- Retrieving a List of Subscriptions
- Retrieving a Subscription
- Retrieving the Next Subscription Code
- Amending a Subscription
- Reactivating a Suspended Subscription
- Suspending a Subscription
- Canceling a Subscription
- Retrieving a List of Payments in a Subscription
  - REST Examples: Retrieving a List of Payments in a Subscription
- Skipping or Restoring Payments Within a Subscription
  - REST Example: Skipping or Restoring a Payment in a Subscription

Additional Features

Visa Platform Connect: Specifications and Conditions for Resellers/Partners

On This Page

Deleting a Plan

You can delete a standard plan that has a draft status. You can also delete a plan that has an active or inactive status and has never been assigned to any subscriptions.

Follow these steps to delete a plan:

In the endpoint path, include the plan ID that you received when you retrieved a list of plans.

Send the request to the Recurring Billing endpoint:

Production:

DELETE https://nabgateway-api.nab.com.au/rbs/v1/plans/{id}

Test:

DELETE https://nabgateway-api-test.nab.com.au/rbs/v1/plans/{id}

REST Example: Deleting a Plan

Response to a Successful Request

{
  "status": "COMPLETED"
}

Error Response

{
    "status": "NOT_FOUND",
    "reason": "NOT_FOUND",
    "message": "One or more fields in the request contains invalid data.",
    "details": [
        {
            "field": "subscriptionInformation.planId",
            "reason": "INVALID_DATA"
        }
    ]
}

Back to top