API Reference
Explore SandboxPartner PortalMerchant Portal

Update Subscription

put
https://sandbox.nmi.com/api/v5/subscriptions/

Update an existing subscription's billing information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The subscription ID to update

Body Params
number
≥ 0

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

integer
0 to 999

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

integer
≥ 1

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

integer
≥ 1

How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with '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'

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 information for REST API payment transactions

shipping_address
object

Shipping address information for REST API payment transactions

order_details
object

Order details and line items for REST API payment transactions

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

Responses

401

Unauthorized

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago