subscription object

Deze pagina’s zijn in het engels ten behoeve van mogelijk internationale ontwikkelaars

This object is used in the following endpoints:

/subscriptions

Information about subscriptions is provided in subscription objects, as defined below.

Parameters		Description

Parameters		Description
`id`	Required	MUST contain a unique identifier of the subscription.
`resource_type`	Required	String representing the resource type, MUST be equal to `subscription`.
`url`	Required	URL of the subscription.
`created_date`	Required	Date time when the subscription was initially created, MUST be a UNIX timestamp, following the timestamp conventions.
`start_date`	Required	Contains the date time when the subscription becomes/became valid, MUST be a UNIX timestamp, following the timestamp conventions.
`end_date`	Optional	If the subscription has an end date, or has ended, contains the end date and time, MUST be a UNIX timestamp, following the timestamp conventions.
`consumer_id`	Required	If the subscription is assigned a data service consumer MUST contain a unique identifier of the data service consumer as an Organisation ID, containing an EORI or KvK number.
`provider_id`	Required	MUST contain a unique identifier of the data service provider as an Organisation ID, containing an EORI or KvK number.
`description`	Optional	MUST contain a human-readable description of the subscription as a string.
`event_type`	Required	MUST be a list with subset of event types that is subscribed to, selected from the list defined by the data service provider.
`status`	Required	MUST be the status of the subscription. Possible values are: `active`, `inactive`. See the lifecycle of a subscription for more information.
`webhook_url`	Required	MUST be the URL of the data service consumer that notifications shall be sent to.

{
  "id": "sub_123",
  "resource_type": "subscription",
  "url": "/subscriptions/sub_123",
  "created_date": "1663752217",
  "start_date": "1663801199",
  "end_date": "1663801199",
  "consumer_id": "EU.EORI.NL000123456",
  "provider_id": "EU.EORI.NL000345678",
  "description": "detailed description of the subscription",
  "event_type": ["Modified,","Deleted"],
  "status": "active",
  "webhook_url": "https://example.com/notifications"
}