Update or Create Order Template

Creates a new order template or updates an existing one (upsert). If templateId is omitted from the URL, one is auto-generated.

A template stores the same fields as an order (name, description, amount, currency, and an optional pay schedule),
but is inert: it is hidden from normal order flows, is never billed, and carries no status. A name is required
so the template can be identified in a picker.
For one-time (UNSCHEDULED) templates, use dueInDays to specify a due date relative to when the template is used.
Templates do not store customers or billing tokens — those are supplied when the template is instantiated.

Path Params
string
required

The merchant ID

string
required

The string identifier for the template.

Body Params
string | null

Unique identifier for the order

string | null

Short label for the order, e.g. the product, service, or membership name

string | null

Description of the order

number | null

Total amount of the order

string

Currency of the order amount in ISO 4217 format

integer | null

Template-only: number of days after instantiation that the order becomes due. Resolved to an absolute due date when the template is used. Only used for UNSCHEDULED templates.

paySchedule
object | null

Payment schedule for the order

string

List of customers associated with this order

Headers
string
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json