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

Title

string | null

The title of the subscription template.

Recommended

boolean | null

Whether this subscription template is recommended.

Active

boolean | null

Whether the subscription template is active.

Benefits

array of strings | null

The benefits of the subscription.

Benefits

Keywords

string | null

Keywords associated with the subscription template, shown when the template is recommended.

Tags

string | null

This is used to describe the subscription template.

CtaText

string | null

The call-to-action text for the subscription template.

Image

string | null

Base64-encoded image data for the subscription template. Send null to remove.

Visibility

string

enum

Allowed:

ddrDescription

string | null

The description to use when creating DDRs from this template.

RecurringAmount

double | null

The amount to be charged on a recurring basis.

Frequency

string

enum

Allowed:

StartDateCondition

string

enum

Allowed:

StartDate

date | null

The specific start date for the subscription.

EndConditionAmount

double | null

The total amount after which the subscription should end.

UpfrontAmount

double | null

The amount to be charged upfront.

UpfrontDateCondition

string

enum

Allowed:

UpfrontDateDays

int32 | null

The number of days for the upfront date condition.

UpfrontDate

date | null

The specific date for the upfront payment.

FailureOption

int32

enum

Allowed:

ReminderDays

int32 | null

The number of days before a payment to send a reminder.

OnchargedFees

string of objects | null

enum

The fees to be on-charged to the customer.
Valid values include: dishonour - charge the fees for payment failures back to the customer, perdebit - charge the per debit fee and msf to the customer,
setup - charge the setup fee to the customer, reminder - charge the reminder fee to the customer

Allowed:

DigitalAgreementCode

string | null

The code of the Digital Agreement document. Send null to remove.

UpdateExistingDdrs

boolean | null

When SubscriptionDetails fields have changed, whether to update existing active DDRs to the new version (true) or keep 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