Webhook Subscriptions

List all Subscriptions

This operation returns a list of subscriptions.

Required scope: subscriptions:read

get/subscriptions

Request

  • Base URL
    https://sandbox.signup.nmi.com/api/v1
  • URL
    https://sandbox.signup.nmi.com/api/v1/subscriptions
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: subscriptions:read

Query parameters

pageinteger

Page number

per_page10 | 20 | 50 | 100

Number of subscriptions per page

Response

Successful response example

current_pageinteger required

The current page number

last_pageinteger required

The last page number

per_page10 | 20 | 50 | 100 required

The number of items per page (allowed values: 10, 20, 50, 100)

totalinteger required

The total number of items

Example response

{
  "subscriptions": [
    {
      "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.