API Reference
Explore SandboxPartner PortalMerchant Portal

Create Subscription

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

Create a new subscription. A subscription can be associated with an existing plan or created as a custom subscription.

Body Params
string
required
length ≤ 50

The plan ID of the plan that the subscription will be associated with

number
≥ 0

The plan amount to be charged each billing cycle (for custom plans). Format: x.xx

integer
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
≥ 1

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

integer
1 to 31

The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'

string
length ≤ 14

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

number
≥ 0

Transaction amount (optional for subscriptions - can use plan amount)

boolean

If set to true, the subscription will be paused

string

Customer vault ID to use for the subscription

payment_details
object
required

Payment method details for credit card, ACH, or tokenized payments

billing_address
object

Billing address information for REST API payment transactions

shipping_address
object

Shipping address information for REST API payment transactions

order_details
object

Order details and line items for REST API payment transactions

merchant_defined_fields
object

Custom fields that can be set up in merchant control panel under Settings->Merchant Defined Fields

customer_vault
object

Customer vault information for storing payment methods

Responses

401

Unauthorized

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago