Update Subscription

put

https://sandbox.nmi.com/api/v5/subscriptions/{subscription_id}

Update an existing subscription's billing information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscription_id

integer

required

The subscription ID to update

Body Params

plan_amount

number

≥ 0

The plan amount to be charged each billing cycle. 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'

paused_subscription

boolean

If set to true, the subscription will be paused

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

404Subscription not found