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…

Never Use Real API Keys

Use Sandbox keys with the Try It feature. Do not enter production API keys when testing.

Body Params

Subscription associated with an existing plan

payment_details

required

Payment method details. Exactly one variant: raw card data, ACH (check) data, payment_token, wallet payloads, or retail card-present data from a card reader. Do not combine fields from different variants.

customer_vault

object

Store the inline payment_details from this request in the customer vault.

plan_id

string

required

Plan ID to use for the subscription

paused_subscription

boolean

If set to true, the subscription will be paused

billing_address

object

Billing address for a payment transaction request.

shipping_address

object

Shipping address and information

order_details

object

Order details and line items

merchant_defined_fields

object

Custom fields configured in the merchant control panel under Settings → Merchant Defined Fields (field_1 through field_20).

cardholder_auth

Cardholder authentication data. Use the 3-D Secure variant for EMV authentication results. Use the Decrypted wallet variant for merchant-decrypted Apple Pay or Google Pay, which relays the cryptogram and ECI to the 3-D Secure fields.

start_date

string

length between 8 and 14

^(\d{8}|\d{14})$

The date the subscription's first charge occurs. Format: YYYYMMDD (optionally YYYYMMDDHHMMSS). Defaults to the next billing date derived from the plan schedule when omitted.

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Never Use Real API Keys

200Success

400Bad Request - Validation Error