NMnmi
Subscriptions

Update Subscription

Update an existing subscription's billing information.

put/v5/subscriptions/{subscription_id}

Request

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

Path parameters

subscription_idinteger required

The subscription ID to update

Request body

plan_amountnumber

The plan amount to be charged each billing cycle. Format: x.xx

plan_paymentsinteger

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

day_frequencyinteger

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

month_frequencyinteger

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

day_of_monthinteger

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

paused_subscriptionboolean

If set to true, the subscription will be paused

start_datestring

The date the subscription's next/first charge occurs. Format: YYYYMMDD (optionally YYYYMMDDHHMMSS).

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.