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

Plan ID to use for the subscription

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

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 and information

shipping_address

object

Shipping address and information

order_details

object

Order details and line items

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

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.

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

200Success

400Bad Request - Validation Error