API Reference
Explore SandboxPartner PortalMerchant Portal

Update a Subscription

patch
https://sandbox.signup.nmi.com/api/v1/subscriptions/

Updates an subscription

Required scope: subscriptions:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 20 and 20
^sub_[a-f0-9]{16}$

The ID of the subscription to update

Body Params

Update subscription payload

Update an existing subscription.

string
length ≤ 1024

The callback URL of the subscription.

string
length between 6 and 64

The secret key is used to generate a secure signature with the HMAC-SHA256 hashing algorithm, which is included
in the webhook event Signature header.

events
array of strings
length ≤ 1000

Subscription events

events
Headers
string
length between 10 and 100

Provide a random key (for example, UUID) to make the request idempotent

Responses

Updated 9 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?