Update Plan

put

https://sandbox.nmi.com/api/v5/plans/{id}

Update an existing recurring payment plan. Be careful when updating an existing plan, as all customers signed up for this plan will have their billing changed based on your edits.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The plan ID to update

Body Params

month_frequency

integer

required

1 to 24

How often, in months, to charge the customer.

day_of_month

integer

required

1 to 31

The day of the month that the customer will be charged. For months without 29, 30, or 31 days, the charge will be on the last day.

plan_amount

number

required

≥ 0

The plan amount to be charged each billing cycle. Format: x.xx

plan_payments

integer

required

0 to 999

The number of payments before the recurring plan is complete. Use '0' for until canceled

string

length ≤ 50

New plan identifier when renaming the plan. Omit to keep the existing ID from the path. Distinct from the path parameter {id}, which identifies the plan being updated.

plan_name

string

length ≤ 50

Updated display name of the plan. Optional on update.

current_plan_id

string

length ≤ 50

Existing plan ID being updated. Optional; the path parameter {id} is authoritative and is applied when this is omitted or differs.

Responses

401

Unauthorized

200Success

400Bad Request - Validation Error

404Plan not found