Skip to main content
This page records changes to the DVM APIs. Documentation-only, formatting-only, and specification-format changes are excluded.

Dated history

changed
2025-04-05
  • An offer now has a plan, enabling lifecycle management when a consumer subscribes to an offer.
added
2025-02-06
  • Added the user-terminated code for ELIGIBILITY_DENIED.
  • Added support for the optional billingIdentifier field in requests.
  • Added additional fields.
changed
2024-11-15
  • Updated the Outbound Eligibility API request and response models.
initial-release
2024-10-17
  • Initial release.
initial-release
2024-10-17
  • Initial release.

Earlier version history

The source specifications do not record dates for the entries below. They are shown in the order recorded in each specification.

Reseller to DVM — Entitlements

added
  • Added the /notify endpoint for asynchronous notification-actioned confirmation.
added
  • Added optional sharedCustomerId to all responses.
added
  • Added 409 CONFLICT to POST /v1/entitlement/cancel/{entitlementId}.
  • Added 409 CONFLICT to POST /v1/entitlement/revoke/{entitlementId}.
added
  • Added financeData support to all responses.
  • Added ACTIVE-ENDING as a new status.
added
  • Added dateAutoSuspend to create and patch entitlement methods.
  • Added dateAutoSuspend to response objects when the parameter has a value.
added
  • Added entitlementBenefits to the patch entitlement method.
added
  • Added ExternalEntitlementId to create and patch requests.
  • Added ExternalEntitlementId to responses.
  • Added a GET call to /v1/entitlement to retrieve entitlement information using ExternalEntitlementId.
added
  • Added support for a 201 Created response for Create Entitlement.
  • Added serviceFlow to the extraInformation.source object.
breakingchanged
  • Removed support for ACTIVATION_ statuses.
  • Extended extraInformation to include communicationInformation and source objects.
added
  • Added the optional extraInformation object containing clientDevice.
added
  • Added ResumedDate to the Entitlement object. The date is set when using the Resume Entitlement method.
added
  • Added Suspend Entitlement and Resume Entitlement methods.
added
  • Added Entitlement Report.
initial-release
  • Initial release.

Content provider to DVM — Entitlements

added
  • Added optional sharedCustomerId to all responses.
added
  • Added extraInformation to PATCH /v1/entitlement/{merchantEntitlementId} and the response object.
  • Added merchantExtensionData to the response object.
  • Added merchantBangoExtensionData to the response object.
  • Added customerId and resellerId to the response object.
  • Added POST /v1/merchant/entitlement/report to retrieve entitlements by bangoUserId.
added
  • Added financeData to POST /v1/entitlement/activate/{merchantEntitlementId}.
  • Added financeData to PATCH /v1/entitlement/{merchantEntitlementId}.
  • Added financeData to POST /v1/entitlement/terminate/{merchantEntitlementId}.
  • Added financeData to the response object.
added
  • Added entitlementBenefits to PATCH /v1/entitlement/{merchantEntitlementId}.
initial-release
  • Initial release.

DVM to content provider — Entitlements

added
  • Added optional sharedCustomerId to all Bango-initiated outbound requests.
breakingadded
  • Removed extensionData from POST /v1/entitlement.
  • Removed POST /v1/entitlement/suspend/{merchantEntitlementId} and POST /v1/entitlement/resume/{merchantEntitlementId}.
  • Removed merchantExtensionData from the response object.
  • Added bangoUserId, productId, offerId, customerId, merchantExtensionData, and extraInformation to POST /v1/entitlement/terminate/{merchantEntitlementId}.
  • Added merchantExtensionData to create, patch, terminate, and eligibility-check request objects.
  • Added financeData to create, patch, and terminate request objects.
  • Added status to create, patch, and terminate request objects.
  • Added merchantBangoExtensionData to the request object.
added
  • Added 409 CONFLICT to POST /v1/entitlement/terminate/{merchantEntitlementId}.
added
  • Added entitlementBenefits to PATCH /v1/entitlement.
  • Added extraInformation to PATCH /v1/entitlement.
added
  • Added customerId to POST /v1/entitlement and PATCH /v1/entitlement.
added
  • Added resellerId to PATCH /v1/entitlement and POST /v1/entitlement/terminate/{merchantEntitlementId}.
added
  • Added extensionData to PATCH /v1/entitlement.
  • Added offerId and customerIdentifier to POST /v1/entitlement/checkeligibility.
  • Added support for a 201 Created response for POST /v1/entitlement.
initial-release
  • Initial release.

DVM to reseller — Notifications

added
  • Added the METADATA_UPDATE value to notificationReason for POST /.
  • Added the TERMINATION_PENDING value to notificationReason for POST /.
  • Added ACTIVE-ENDING as a status.
initial-release
  • Initial release.