Updates a payment plan.

put

https://example.com/episerverapi/commerce/paymentplans/{orderGroupId}

Path Params

orderGroupId

int32

required

Payment plan id.

Body Params

Payment plan model.

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

Responses

200

Success

204

The payment plan is saved.

400

If the payment plan model is not valid.

401

If user does not have enough permission for this request.

404

If payment plan does not exist.

Language

Response

Click Try It! to start a request and see the response here!