braintree · Schema

ModificationCollection

A collection of add-on or discount operations to apply when creating or updating a subscription.

Properties

Name Type Description
add array Add-ons or discounts to add to the subscription.
update array Existing add-ons or discounts to update on the subscription.
remove array Identifiers of add-ons or discounts to remove from the subscription.
View JSON Schema on GitHub

JSON Schema

braintree-modificationcollection-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ModificationCollection",
  "title": "ModificationCollection",
  "type": "object",
  "description": "A collection of add-on or discount operations to apply when creating or updating a subscription.",
  "properties": {
    "add": {
      "type": "array",
      "description": "Add-ons or discounts to add to the subscription.",
      "items": {
        "$ref": "#/components/schemas/ModificationAdd"
      }
    },
    "update": {
      "type": "array",
      "description": "Existing add-ons or discounts to update on the subscription.",
      "items": {
        "$ref": "#/components/schemas/ModificationUpdate"
      }
    },
    "remove": {
      "type": "array",
      "description": "Identifiers of add-ons or discounts to remove from the subscription.",
      "items": {
        "type": "string"
      }
    }
  }
}