Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

OAuth2 client_credentials authorization. Obtain a new access_token when it expires.

Query Parameters

merchant_id
string
required

Required business identifier assigned by BillBuddy, up to 20 characters; must belong to the merchant associated with the OAuth credentials.

Maximum string length: 20
page
integer | null
default:1

Page number. Defaults to 1.

Required range: x >= 1
page_size
integer | null
default:20

Items per page. Defaults to 20; no maximum is specified.

Required range: x >= 1
name
string | null

Partial match on the template name.

Maximum string length: 255
frequency
enum<integer> | null

Template debit frequency: 1 One-off, 3 Weekly, 4 Fortnightly, 5 Monthly, 6 Quarterly, 7 Half Yearly, 8 Yearly, 12 Custom.

Available options:
1,
3,
4,
5,
6,
7,
8,
12,
null
min_price

Minimum latest template price. Amounts use major currency units, for example 10.50 means AUD 10.50, with at most two decimal places. Numbers and numeric strings are accepted, with a minimum of 0; the same range applies to both types.

Required range: x >= 0Must be a multiple of 0.01
max_price

Maximum latest template price. Amounts use major currency units, for example 10.50 means AUD 10.50, with at most two decimal places. Numbers and numeric strings are accepted, with a minimum of 0; the same range applies to both types.

Required range: x >= 0Must be a multiple of 0.01
start_create
string<date> | null

Creation date range start, inclusive from 00:00:00. Must use YYYY-MM-DD.

end_create
string<date> | null

Creation date range end, inclusive through 23:59:59. Must use YYYY-MM-DD.

start_update
string<date> | null

Update date range start, inclusive from 00:00:00. Must use YYYY-MM-DD.

end_update
string<date> | null

Update date range end, inclusive through 23:59:59. Must use YYYY-MM-DD.

Response

HTTP 200. Distinguish success, business errors, validation errors and business authentication errors using the response body code.

Success response.

code
enum<integer>
required

0 means the template list was retrieved successfully.

Available options:
0
message
string
required

Response message.

data
object
required

Pagination structure. The template array is located at data.data.