Delete a Subscription
DELETE /subscriptions/{subscription}
Environment and operation
Use this endpoint contract with the account and environment assigned to your integration. Values in angle brackets are placeholders. This reference does not execute requests. Documented server https://sandbox.signup.nmi.com/api/v1 https://secure.nmi.com/api/v5/signup Schema reference: field definitions do not include every behavioral rule. Follow the workflow guidance and account prerequisites for this operation before submitting requests.
Request route
Deletes a subscription **Required scope:** `subscriptions:write` DELETE /subscriptions/{subscription} Security scheme Type Credential location Scopes oauth oauth2 subscriptions:write
Request language templates
Original transport templates derived from this endpoint’s documented method, server, authentication and media type. Replace path/query/credential placeholders with authorized sandbox values. These examples print the raw status and response; they do not infer business success or retry a request. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request DELETE \ --url 'https://sandbox.signup.nmi.com/api/v1/subscriptions/{subscription}' \ --header 'Authorization: Bearer <access-token>' const response = await fetch("https://sandbox.signup.nmi.com/api/v1/subscriptions/{subscription}", { method: 'DELETE', headers: { "Authorization": "Bearer <access-token>" } }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError request = Request('https://sandbox.signup.nmi.com/api/v1/subscriptions/{subscription}', method='DELETE', headers={'Authorization': 'Bearer <access-token>'}) try: with urlopen(request, timeout=30) as response: print(response.status, response.read().decode()) except HTTPError as error: print(error.code, error.read().decode()) require 'net/http' require 'uri' uri = URI("https://sandbox.signup.nmi.com/api/v1/subscriptions/{subscription}") request = Net::HTTP::Delete.new(uri) request["Authorization"] = "Bearer <access-token>" response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 30) { |http| http.request(request) } puts response.code puts response.body <?php $curl = curl_init('https://sandbox.signup.nmi.com/api/v1/subscriptions/{subscription}'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'DELETE', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Authorization: Bearer <access-token>'] ]); $response = curl_exec($curl); if ($response === false) { throw new RuntimeException(curl_error($curl)); } echo curl_getinfo($curl, CURLINFO_HTTP_CODE), PHP_EOL, $response; curl_close($curl);
Path and query parameters
Required flags apply to the parameter itself. Additional limits and enum values appear in the contract below. Parameter Location Required Type Description Idempotency-Key header false string Provide a random key (for example, UUID) to make the request idempotent subscription path true See schema The ID of the subscription to update [ { "name": "Idempotency-Key", "in": "header", "description": "Provide a random key (for example, UUID) to make the request idempotent", "schema": { "type": "string", "minLength": 10, "maxLength": 100 }, "required": false }, { "name": "subscription", "in": "path", "description": "The ID of the subscription to update", "required": true, "schema": { "$ref": "#/components/schemas/subscription-id" } } ] true
Responses
Match the HTTP status to its response schema below. For financial operations, also inspect the payment outcome before updating your order or retrying. HTTP status Media type Meaning 200 application/json Subscription Deleted 404 application/json Error response for resource not found { "200": { "description": "Subscription Deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Success Code: DELETED", "maxLength": 100 }, "message": { "type": "string", "description": "Success Message", "maxLength": 10000 } } }, "examples": { "success": { "summary": "Subscription deleted", "description": "Subscription deleted", "value": { "code": "DELETED", "message": "Webhook subscription deleted successfully" } } } } } }, "404": { "description": "Error response for resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 100 }, "message": { "type": "string", "description": "Error message", "maxLength": 10000 } } }, "examples": { "not-found": { "summary": "Resource Not Found", "description": "The resource cannot be found", "value": { "code": "NOT_FOUND", "message": "Resource not found" } } } } } } } true
Response fields · 200 · application/json
Field Type Required Description Constraints code string no Success Code: DELETED maxLength: 100 message string no Success Message maxLength: 10000
Response fields · 404 · application/json
Field Type Required Description Constraints code string no Error code maxLength: 100 message string no Error message maxLength: 10000
Referenced schema definitions
References beginning with #/components resolve to these definitions. These are field contracts, not example payment values. Use the applicable variant, required fields and constraints. { "securitySchemes": { "oauth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": { "*": "Full access", "packages:read": "Read packages information", "applications:read": "Read access to applications", "applications:write": "Write access to applications", "subscriptions:read": "Read access to subscriptions", "subscriptions:write": "Write access to subscriptions (subscribe/updated/delete)" } } } } }, "schemas": { "subscription-id": { "type": "string", "description": "The unique identifier of the subscription.", "pattern": "^sub_[a-f0-9]{16}$", "minLength": 20, "maxLength": 20 }, "event-types": { "type": "string", "enum": [ "application.updated.data.requested", "application.approved", "application.declined", "application.cancelled", "application.merchant.closed", "application.merchant.boarded", "merchant.chargeback.added", "merchant.deposit.new", "merchant.first-batch", "merchant.processing.start", "merchant.processing.stop", "merchant.residuals.published", "merchant.retrieval.added", "merchant.statement.new" ], "example": "application.merchant.boarded" } }, "responses": { "error-not-found": { "description": "Error response for resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 100 }, "message": { "type": "string", "description": "Error message", "maxLength": 10000 } } }, "examples": { "not-found": { "summary": "Resource Not Found", "description": "The resource cannot be found", "value": { "code": "NOT_FOUND", "message": "Resource not found" } } } } } } } } true
Integration checks
Validate the request against its selected schema before submission. Keep secrets outside browser code. Test permitted and denied account access, validation failures and interrupted responses in the sandbox. Account-management or messaging operations require the corresponding partner access and intended recipient context.