Modify a Direct Debit Template

patch

https://api.test.payadvantage.com.au/v3/direct_debit_templates/{code}

Updates an existing subscription template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

code

string

required

The unique code of the subscription template.

Body Params

TemplateTitle

string | null

The template's name, shown to merchants when choosing a template. Max 50 characters.

Recommended

boolean | null

Whether to highlight this template as recommended to customers.

Active

boolean | null

Whether the template can be used.

Benefits

array of strings | null

Selling-point lines shown to customers on the hosted payment page.

Benefits

RecommendedLabel

string | null

Short badge shown when the template is marked recommended (e.g. "Best value").

TemplateDescription

string | null

Longer description of the template shown to customers on the hosted payment page.

ButtonText

string | null

Call-to-action label for the template's button on the hosted payment page (e.g. "Join now").

Image

string | null

Base64-encoded image (PNG, JPG, GIF or SVG) shown for this template. Send null to remove.

Visibility

string

enum

Whether the template appears in your public template selection (public) or is hidden (private).

Allowed:

DdrDescription

string | null

The payment description applied to direct debits created from this template. Max 50 characters.

RecurringAmount

double | null

Amount charged each recurring instalment, in AUD.

Frequency

string

enum

How often recurring instalments are charged (e.g. weekly, monthly).

Allowed:

StartDateCondition

string

enum

When the recurring schedule starts: today or a fixed on_date.

Allowed:

StartDate

date | null

Exact date the recurring schedule starts. Required when the start date condition is on_date.

EndConditionAmount

double | null

Total amount at which the subscription completes; once collected, no further instalments are taken. Send null for an open-ended subscription.

UpfrontAmount

double | null

One-off amount charged before the recurring schedule begins (e.g. a deposit or setup fee).

UpfrontDateCondition

string

enum

When the upfront amount is charged: today, a fixed on_date, or a number of days before/after the first instalment.

Allowed:

UpfrontDateDays

int32 | null

Days before/after the first instalment to charge the upfront amount. Used with days_before_first_instalment or days_after_first_instalment.

UpfrontDate

date | null

Exact date to charge the upfront amount. Used with the on_date upfront date condition.

FailureOption

string

enum

How a failed (dishonoured) payment is handled.

Allowed:

ReminderDays

int32 | null

Days before each payment to send the customer a reminder (0–3; 0 = no reminder).

OnchargedFees

string of objects | null

enum

Which fees are passed on to the customer.
Valid values: setup - charge the setup fee, perdebit - charge the per-debit fee and MSF, dishonour - charge payment-failure fees, reminder - charge the reminder fee.

Allowed:

DigitalAgreementCode

string | null

Code of a Digital Agreement to attach. Templates with a digital agreement can only create digital direct debits. Send null to remove.

UpdateExistingDdrs

boolean | null

When subscription-detail fields change, whether to move existing attached debits to the new version (true) or leave them on the current version (false).

Responses

204

NoContent

400Bad request

401User is not authorized

403The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort

404The requested resource could not be found

422The request was well-formed but was unable to be followed due to semantic errors

429Request limit exceeded

500Internal server error

504Gateway timeout