NMnmi
Subscriptions

List Subscriptions

Retrieve a list of subscriptions for the merchant with optional filtering and cursor-based pagination.

To look up a single subscription, use Get Subscription.

get/v5/subscriptions

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/subscriptions
  • Auth
    API key in header Authorization

Query parameters

customer_vault_idstring

Filter by the customer vault ID the subscription is attached to.

date_fromstring date

Filter results created on or after this date. Must be a valid calendar date in YYYY-MM-DD format.

date_tostring date

Filter results created on or before this date. Must be a valid calendar date in YYYY-MM-DD format.

cursorstring

Cursor for pagination, returned as next_cursor on the previous page. Omit for the first page.

per_pageinteger

Number of results to return per page (default: 10, max: 100).

Response

Success

per_pageinteger

Number of subscriptions requested per page

has_moreboolean

Whether another page is available

next_cursorstring

Cursor for the next page. Pass it as the cursor parameter on the next request. Omitted when there are no more results.

Changes

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