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:
  1. Send the request to the Recurring Billing endpoint:
    Test:
    GET https://
    nabgateway-developer.nab.com.au
    /rbs/v1/plans/code
    Production:
    GET https://
    nabgateway-developer.nab.com.au
    /rbs/v1/plans/code
  2. Check the response message to make sure the request was successful. A 200-level HTTP response code indicates success. For information about response codes, see
    Transaction response codes
    .

REST Example: Retrieving a Plan Code

Response to a Successful Request
{
    "code": "1619310019",
}
Error Response
{
  "status": "NOT_FOUND",
  "reason": "INVALID_DATA"
}