CreateAgreementRequest

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/CreateAgreementRequest.json",
  "title": "CreateAgreementRequest",
  "type": "object",
  "description": "The Agreement Request Payload",
  "properties": {
    "description": {
      "type": "string",
      "description": "A human-readable description of the purpose of the agreement for recurring payments. We\u2019ll show the description to your user when they make their first payment to activate this agreement. Limited to 255 characters.",
      "example": "Dorset Council 2022/23 council tax subscription.",
      "maxLength": 255,
      "minLength": 1
    },
    "reference": {
      "type": "string",
      "description": "Associate a reference with this agreement to help you identify it. Limited to 255 characters.",
      "example": "CT-22-23-0001",
      "maxLength": 255,
      "minLength": 1
    },
    "user_identifier": {
      "type": "string",
      "description": "Associate an identifier with the user who will enter into this agreement with your service.user_identifier is not unique \u2013 multiple agreements can have identical user_identifier values.You should not include personal data in user_identifier.",
      "example": "user-3fb81107-76b7-4910",
      "maxLength": 255,
      "minLength": 1
    }
  }
}