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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Subscription associated with an existing plan

plan_id

string

required

length ≤ 50

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

plan_amount

number

≥ 0

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

plan_payments

integer

0 to 999

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

day_frequency

integer

≥ 1

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

month_frequency

integer

≥ 1

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

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'

start_date

string

length ≤ 14

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

amount

number

≥ 0

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

paused_subscription

boolean

If set to true, the subscription will be paused

customer_vault_id

string

Customer vault ID to use for the subscription

payment_details

required

Payment method details. Exactly one variant: raw card data, ACH (check) data, payment_token, Apple Pay encrypted payload, or Google Pay encrypted payload. Do not combine fields from different variants.

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

200Success

400Bad Request - Validation Error