NMnmi
Subscriptions

Create Subscription

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

post/v5/subscriptions

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/subscriptions
  • Auth
    API key in header Authorization

Request body

OR
OR
OR

Response

Success

object'subscription' required

Resource type identifier

idstring required

Subscription ID

created_datestring date-time

Date the subscription was created, in UTC ISO 8601 format

start_datestring date-time nullable

Subscription start date in UTC ISO 8601 format

next_billing_datestring date-time nullable

Next billing date in UTC ISO 8601 format

amountstring

Subscription amount

customer_vault_idstring

Customer vault ID associated with the subscription

delayed_conditionstring

Delayed condition

paused_subscription0 | 1

Whether the subscription is paused (0 = active, 1 = paused)

Changes

No recorded changes to this operation across all 1 revision of this API.