Creates a new payment plan.

post

https://example.com/episerverapi/commerce/paymentplans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payment plan model.

Payment Plan is a type of order that will be a recurring order.

addressId

string | null

Address ID.

affiliateId

uuid

Affiliate ID (GUID).

billingCurrency

string | null

Billing currency.

customerId

uuid

Customer ID (GUID).

customerName

string | null

Customer name.

handlingTotal

double

Handling total.

instanceId

uuid

Instance ID (GUID).

marketId

string | null

Market ID.

name

string

required

Order name.

orderAddresses

array of objects | null

List of addresses.

orderAddresses

orderForms

array of objects | null

List of order forms.

orderForms

orderGroupId

int32

Order group ID.

orderNotes

array of objects | null

List of order notes.

orderNotes

owner

string | null

Owner name.

ownerOrg

string | null

Owner's organization name.

providerId

string | null

Provider ID.

shippingTotal

double

Shipping total.

status

string | null

Status. Valid values:

AwaitingExchange
Cancelled
Completed
InProgress
OnHold
PartiallyShipped.

subTotal

double

Sub-total.

taxTotal

double

Tax total.

total

double

Total.

modified

date-time

Modified date.

created

date-time

Created date.

properties

array of objects | null

Gets the list of key value pairs for dealing with custom properties.

properties

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

If the payment plan model is not valid.

401

If user does not have enough permission for this request.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200The payment plan is saved.