API Reference
Explore SandboxPartner PortalMerchant Portal

Create Plan

post
https://sandbox.nmi.com/api/v5/plans

Create a new recurring payment plan. Plans can be used to define recurring billing schedules that subscriptions can be associated with.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 50

The unique identifier for the plan

string
required
length ≤ 50

The display name of the plan

number
required
≥ 0

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

integer
required
0 to 999

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

integer
≥ 1

How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'

integer
required
1 to 24

How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'

integer
required
1 to 31

The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day

string
length ≤ 14

The first day that the customer will be charged. Format: YYYYMMDD

Responses

401

Unauthorized

Updated 3 months ago

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

Updated 3 months ago