Webhook Subscriptions

Update a Subscription

Updates an subscription

Required scope: subscriptions:write

patch/subscriptions/{subscription}

Request

Base URL
https://sandbox.signup.nmi.com/api/v1
URL
https://sandbox.signup.nmi.com/api/v1/subscriptions/{subscription}
Auth
OAuth 2
Client credentials
Token URL: /oauth/token scopes: subscriptions:write

Path parameters

subscriptionstring required

The unique identifier of the subscription.

The ID of the subscription to update

Headers

Idempotency-Keystring

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

Request body

callback_urlstring

The callback URL of the subscription.

secretstring

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.

eventsEventTypes[]

Subscription events

Example request

{
  "events": [
    "application.merchant.boarded"
  ]
}

Response

Subscription updated successfully

idstring required

The unique identifier of the subscription.

callback_urlstring

The callback URL of the subscription.

status'active' | 'inactive' required

eventsEventTypes[] required

Subscription events

created_atstring date-time required

The date and time when the application was created.

updated_atstring date-time required

The date and time when the application was last updated.

Example response

{
  "events": [
    "application.merchant.boarded"
  ],
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Changes

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