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

Retrieving a Plan Code

When you specify your own plan codes, you can request the next consecutive alphabetical or numeric plan code based on the last plan code that you specified. For example, if the last plan code that you specified was

Plan104

, the system returns the code

Plan105

.

Follow these steps to retrieve a plan code:

Send the request to the Recurring Billing endpoint:

Production:

GET https://nabgateway-api.nab.com.au/rbs/v1/plans/code

Test:

GET https://nabgateway-api-test.nab.com.au/rbs/v1/plans/code

REST Example: Retrieving a Plan Code

Response to a Successful Request

{
    "code": "1619310019",
}

Error Response

{
  "status": "NOT_FOUND",
  "reason": "INVALID_DATA"
}

Back to top