NMnmi
Plans

Get Plan

Retrieve details for a specific recurring payment plan.

get/v5/plans/{id}

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/plans/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

The plan ID to retrieve

Response

Success

object'plan' required

Resource type identifier

idstring required

Plan ID (SKU)

plan_namestring

Plan name

plan_amountstring

Plan amount

plan_paymentsstring

Number of payments (0 = until canceled)

day_frequencystring

Day frequency (0 if not applicable, empty if not set)

month_frequencystring

Month frequency (0 if not applicable, empty if not set)

day_of_monthstring

Day of month (empty if not applicable)

Changes

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