NMnmi
Webhook Subscriptions

Get Subscription Information

Returns information about a given subscription

Required scope: subscriptions:read

get/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:read

Path parameters

subscriptionstring required

The unique identifier of the subscription.

The ID of the subscription to retrieve

Response

Subscription information retrieved 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.