DELETE /subscriptions/{id}

Owned by Bauke Rietveld
Last updated: 17 Jun 2024Version comment
2 min read

Removes a specific subscription with the given ID at a data service provider. This method is possible on all subscriptions with status equal to active and results in their status being set to inactive such that they cannot be used. (see Lifecycle of a Subscription for more information)

DSGO.Basis: Data service providers MUST support a DELETE call to a /subscriptions/{id} endpoint to remove a specific subscription

Request

Authorisation

The data service provider is responsible for determining a suitable authorisation policy for their subscriptions objects. See Autorisatie for more information.

Parameters

For information about the parameters that are common to the trust framework’s API’s see Generic API Requirements, and for parameters common to all subscriptions methods, see /subscriptions.

DSGO.Basis: Data service providers MUST validate that the {id} of a DELETE request to a /subscriptions/{id} is valid, exists and is available to the data service consumer

DSGO.Basis: Data service providers MUST validate that the subscription object being deleted complies with their data service specific subscription requirements

Responses

200 OK

Successful, the subscription is deleted.

404 Not found