{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."
    },
    "name": {
      "type": "string",
      "description": "The name of the attachment."
    },
    "label": {
      "type": "string",
      "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. \n"
    },
    "remoteUrl": {
      "type": "string",
      "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads."
    },
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment."
    },
    "accessControl": {
      "type": "string",
      "description": "Valid values are `sender` and `senderAndAllRecipients`."
    },
    "attachmentType": {
      "type": "string",
      "description": "Specifies the type of the attachment for the recipient."
    }
  },
  "description": "Contains information about an attachment.",
  "x-ms-summary": "Contains information about an attachment.",
  "x-ds-definition-name": "attachment"
}

{
  "type": "object",
  "properties": {
    "totalCount": {
      "type": "string",
      "description": "The number of times the authentication method was used. "
    },
    "lastProvider": {
      "type": "string",
      "description": "The last provider that authenticated the user. "
    },
    "lastTimestamp": {
      "type": "string",
      "description": " The data and time the user last used the authentication method. "
    },
    "authenticationType": {
      "type": "string",
      "description": "Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. "
    }
  },
  "description": "Contains information about the method used for authentication.",
  "x-ms-summary": "Contains information about the method used for authentication.",
  "x-ds-definition-name": "authenticationMethod"
}

{
  "type": "object",
  "properties": {
    "ofacResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "yahooResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "googleResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "liveIDResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "openIDResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "sTANPinResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "smsAuthResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "twitterResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "facebookResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "idLookupResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "linkedinResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "ageVerifyResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "phoneAuthResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "accessCodeResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "salesforceResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "anySocialIDResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "idQuestionsResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "signatureProviderResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "identityVerificationResult": {
      "$ref": "#/components/schemas/eventResult"
    }
  },
  "description": "A complex element that contains information about a user's authentication status.",
  "x-ms-summary": "A complex element that contains information about a user's authentication status.",
  "x-ds-definition-name": "authenticationStatus"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the authorization user."
    },
    "email": {
      "type": "string",
      "description": "The email address of the authorization user."
    },
    "userId": {
      "type": "string",
      "description": "The ID of the authorization user."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "authorizationUser"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.\n\nMaximum of length: 100 characters. "
    },
    "bccEmailAddressId": {
      "type": "string",
      "description": "Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. \n \nExample: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address."
    }
  },
  "description": "Contains information about the BCC email address.",
  "x-ms-summary": "Contains information about the BCC email address.",
  "x-ds-definition-name": "bccEmailAddress"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "The helper URI for retrieving the BCC email archive."
    },
    "email": {
      "type": "string",
      "description": "The BCC email address to use for archiving DocuSign messages.\n\nExample: customer_bcc@example.com"
    },
    "status": {
      "type": "string",
      "description": "The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the BCC email archive configuration was created."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the BCC email archive configuration was last modified."
    },
    "accountId": {
      "type": "string",
      "description": "The ID of the account that owns the BCC email archive configuration."
    },
    "createdBy": {
      "$ref": "#/components/schemas/userInfo"
    },
    "modifiedBy": {
      "$ref": "#/components/schemas/userInfo"
    },
    "bccEmailArchiveId": {
      "type": "string",
      "description": "The ID of the BCC email archive configuration."
    },
    "emailNotificationId": {
      "type": "string",
      "description": "The GUID of the activation email message sent to the BCC email address."
    }
  },
  "description": "This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).",
  "x-ms-summary": "This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).",
  "x-ds-definition-name": "bccEmailArchive"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The BCC email address used to archive the emails that DocuSign generates. \n\nExample: customer_bcc@example.com"
    },
    "action": {
      "type": "string",
      "description": "The action taken on the BCC email archive configuration.\n\nExamples: \n\n- `CREATED`: The BCC email archive configuration has been created.\n- `UPDATED`: The BCC email address has been activated by clicking on the activation link in the activation email message.\n- `CLOSED`: The BCC email address has been marked as closed is no longer used for archiving."
    },
    "status": {
      "type": "string",
      "description": "The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the BCC email address was last modified."
    },
    "accountId": {
      "type": "string",
      "description": "The ID of the account that owns the BCC email archive configuration."
    },
    "modifiedBy": {
      "$ref": "#/components/schemas/userInfo"
    }
  },
  "description": "Contains details about the history of the BCC email archive configuration.",
  "x-ms-summary": "Contains details about the history of the BCC email archive configuration.",
  "x-ds-definition-name": "bccEmailArchiveHistory"
}

{
  "type": "object",
  "properties": {
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    },
    "bccEmailArchiveHistory": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailArchiveHistory"
      },
      "description": "A list of changes to the BCC email archive configuration."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bccEmailArchiveHistoryList"
}

{
  "type": "object",
  "properties": {
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    },
    "bccEmailArchives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailArchive"
      },
      "description": "A list of  BCC email archive configurations."
    }
  },
  "description": "Contains a list of BCC email archive configurations.",
  "x-ms-summary": "Contains a list of BCC email archive configurations.",
  "x-ds-definition-name": "bccEmailArchiveList"
}

{
  "type": "object",
  "properties": {
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPrice"
      },
      "description": ""
    },
    "blocked": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingDiscount"
      },
      "description": ""
    },
    "unitPrice": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "chargeName": {
      "type": "string",
      "description": "Provides information on what services the charge item is for.\n\nThe following table provides a description of the different chargeName values available at this time.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |"
    },
    "chargeType": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "usedQuantity": {
      "type": "string",
      "description": ""
    },
    "allowedQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "includedQuantity": {
      "type": "string",
      "description": ""
    },
    "lastEffectiveDate": {
      "type": "string",
      "description": ""
    },
    "firstEffectiveDate": {
      "type": "string",
      "description": ""
    },
    "chargeUnitOfMeasure": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "incrementalQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Contains information about a billing charge.",
  "x-ms-summary": "Contains information about a billing charge.",
  "x-ds-definition-name": "billingCharge"
}

{
  "type": "object",
  "properties": {
    "billingChargeItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingCharge"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing charge response object.",
  "x-ms-summary": "Defines a billing charge response object.",
  "x-ds-definition-name": "billingChargeResponse"
}

{
  "type": "object",
  "properties": {
    "discount": {
      "type": "string",
      "description": ""
    },
    "endQuantity": {
      "type": "string",
      "description": ""
    },
    "beginQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingDiscount"
}

{
  "type": "object",
  "properties": {
    "entityName": {
      "type": "string",
      "description": ""
    },
    "billingProfile": {
      "type": "string",
      "description": "The type of billing method on the account. Valid values are: \n\n- `direct`\n- `web`"
    },
    "externalEntityId": {
      "type": "string",
      "description": ""
    },
    "isExternallyBilled": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingEntityInformationResponse"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "The total amount of the purchase."
    },
    "balance": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "dueDate": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve invoice information."
    },
    "invoiceItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoiceItem"
      },
      "description": "Reserved for DocuSign."
    },
    "pdfAvailable": {
      "type": "string",
      "description": ""
    },
    "invoiceNumber": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "taxableAmount": {
      "type": "string",
      "description": ""
    },
    "nonTaxableAmount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about a billing invoice.",
  "x-ms-summary": "Contains information about a billing invoice.",
  "x-ds-definition-name": "billingInvoice"
}

{
  "type": "object",
  "properties": {
    "quantity": {
      "type": "string",
      "description": "The quantity of envelopes to add to the account."
    },
    "taxAmount": {
      "type": "string",
      "description": ""
    },
    "unitPrice": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "chargeName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "chargeAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceItemId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "taxExemptAmount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about an item on a billing invoice.",
  "x-ms-summary": "Contains information about an item on a billing invoice.",
  "x-ds-definition-name": "billingInvoiceItem"
}

{
  "type": "object",
  "properties": {
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "billingInvoices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoice"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing invoice response object.",
  "x-ms-summary": "Defines a billing invoice response object.",
  "x-ds-definition-name": "billingInvoicesResponse"
}

{
  "type": "object",
  "properties": {
    "currencyCode": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n"
    },
    "accountBalance": {
      "type": "string",
      "description": ""
    },
    "pastDueBalance": {
      "type": "string",
      "description": ""
    },
    "paymentAllowed": {
      "type": "string",
      "description": ""
    },
    "billingInvoices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoice"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingInvoicesSummary"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentId": {
      "type": "string",
      "description": "The ID of the payment."
    }
  },
  "description": "Contains information on a billing plan.",
  "x-ms-summary": "Contains information on a billing plan.",
  "x-ds-definition-name": "billingPayment"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "The total amount of the purchase."
    },
    "paymentId": {
      "type": "string",
      "description": "The ID of the payment."
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "paymentDate": {
      "type": "string",
      "description": ""
    },
    "paymentNumber": {
      "type": "string",
      "description": "When **true,** a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."
    }
  },
  "description": "Defines a billing payment request object.",
  "x-ms-summary": "Defines a billing payment request object.",
  "x-ds-definition-name": "billingPaymentItem"
}

{
  "type": "object",
  "properties": {
    "paymentAmount": {
      "type": "string",
      "description": "The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingPaymentRequest"
}

{
  "type": "object",
  "properties": {
    "billingPayments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPayment"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines an billing payment response object.",
  "x-ms-summary": "Defines an billing payment response object.",
  "x-ds-definition-name": "billingPaymentResponse"
}

{
  "type": "object",
  "properties": {
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "billingPayments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPaymentItem"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing payments response object.",
  "x-ms-summary": "Defines a billing payments response object.",
  "x-ds-definition-name": "billingPaymentsResponse"
}

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "DocuSign's ID for the account plan."
    },
    "planName": {
      "type": "string",
      "description": "The name of the billing plan.\n"
    },
    "paymentCycle": {
      "type": "string",
      "description": " The payment cycle associated with the plan. Valid values: Monthly or Annually. "
    },
    "perSeatPrice": {
      "type": "string",
      "description": "The per seat price for the plan."
    },
    "enableSupport": {
      "type": "string",
      "description": "When **true,** customer support is provided as part of the account plan."
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "seatDiscounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/seatDiscount"
      },
      "description": "A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`."
    },
    "supportPlanFee": {
      "type": "string",
      "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"
    },
    "planFeatureSets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/featureSet"
      },
      "description": "Reserved for DocuSign."
    },
    "appStoreProducts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/appStoreProduct"
      },
      "description": "Reserved for DocuSign."
    },
    "currencyPlanPrices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/currencyPlanPrice"
      },
      "description": "Contains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set."
    },
    "planClassification": {
      "type": "string",
      "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
    },
    "supportIncidentFee": {
      "type": "string",
      "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"
    },
    "otherDiscountPercent": {
      "type": "string",
      "description": "Any other percentage discount for the plan.\n\nExample: `\"0.00\"`"
    }
  },
  "description": "Contains information about a billing plan.",
  "x-ms-summary": "Contains information about a billing plan.",
  "x-ds-definition-name": "billingPlan"
}

{
  "type": "object",
  "properties": {
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "enablePreAuth": {
      "type": "string",
      "description": ""
    },
    "enableSupport": {
      "type": "string",
      "description": "When **true,** customer support is provided as part of the account plan."
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "renewalStatus": {
      "type": "string",
      "description": "The renewal status of the account. Possible values are:\n\n- `auto`: The account automatically renews. \n- `queued_for_close`: The account will be closed at the billingPeriodEndDate. \n- queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`."
    },
    "billingAddress": {
      "$ref": "#/components/schemas/accountAddress"
    },
    "processPayment": {
      "type": "string",
      "description": ""
    },
    "appStoreReceipt": {
      "$ref": "#/components/schemas/appStoreReceipt"
    },
    "downgradeReason": {
      "type": "string",
      "description": "(Optional) The user's reason for downgrading their billing plan."
    },
    "planInformation": {
      "$ref": "#/components/schemas/planInformation"
    },
    "incrementalSeats": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentProcessor": {
      "type": "string",
      "description": ""
    },
    "saleDiscountAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "referralInformation": {
      "$ref": "#/components/schemas/referralInformation"
    },
    "saleDiscountPercent": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "saleDiscountPeriods": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "creditCardInformation": {
      "$ref": "#/components/schemas/creditCardInformation"
    },
    "saleDiscountFixedAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentProcessorInformation": {
      "$ref": "#/components/schemas/paymentProcessorInformation"
    },
    "saleDiscountSeatPriceOverride": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "directDebitProcessorInformation": {
      "$ref": "#/components/schemas/directDebitProcessorInformation"
    }
  },
  "description": "This object contains details about a billing plan.",
  "x-ms-summary": "This object contains details about a billing plan.",
  "x-ds-definition-name": "billingPlanInformation"
}

{
  "type": "object",
  "properties": {
    "invoice": {
      "$ref": "#/components/schemas/billingInvoice"
    },
    "taxAmount": {
      "type": "string",
      "description": ""
    },
    "isProrated": {
      "type": "string",
      "description": "When **true,** the billing plan is prorated."
    },
    "totalAmount": {
      "type": "string",
      "description": ""
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "subtotalAmount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Information used to provide a preview of a billing plan.",
  "x-ms-summary": "Information used to provide a preview of a billing plan.",
  "x-ds-definition-name": "billingPlanPreview"
}

{
  "type": "object",
  "properties": {
    "billingPlan": {
      "$ref": "#/components/schemas/billingPlan"
    },
    "successorPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "A list of billing plans that the current billing plan can be rolled into."
    }
  },
  "description": "Defines a billing plan response object.",
  "x-ms-summary": "Defines a billing plan response object.",
  "x-ds-definition-name": "billingPlanResponse"
}

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "DocuSign's ID for the account plan."
    },
    "planName": {
      "type": "string",
      "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`"
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "paymentCycle": {
      "type": "string",
      "description": "The payment cycle associated with the plan. Valid values: \n\n- `Monthly`\n- `Annually` "
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "billingPlanPreview": {
      "$ref": "#/components/schemas/billingPlanPreview"
    },
    "accountPaymentMethod": {
      "type": "string",
      "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- "
    }
  },
  "description": "Defines a billing plan update response object.",
  "x-ms-summary": "Defines a billing plan update response object.",
  "x-ds-definition-name": "billingPlanUpdateResponse"
}

{
  "type": "object",
  "properties": {
    "billingPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing plans response object.",
  "x-ms-summary": "Defines a billing plans response object.",
  "x-ds-definition-name": "billingPlansResponse"
}

{
  "type": "object",
  "properties": {
    "unitPrice": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "endQuantity": {
      "type": "string",
      "description": ""
    },
    "beginQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingPrice"
}

{
  "type": "object",
  "properties": {
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandLink"
      },
      "description": "An array of `brandLink` objects that contain information about the links that the brand uses."
    },
    "logos": {
      "$ref": "#/components/schemas/brandLogos"
    },
    "colors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "An array of name-value pairs specifying the colors that the brand uses for the following elements:\n\n- Button background\n- Button text\n- Header background\n- Header text"
    },
    "brandId": {
      "type": "string",
      "description": "The ID used to identify a specific brand in API calls."
    },
    "brandName": {
      "type": "string",
      "description": "The name of the brand."
    },
    "resources": {
      "$ref": "#/components/schemas/brandResourceUrls"
    },
    "brandCompany": {
      "type": "string",
      "description": "The name of the company associated with the brand."
    },
    "emailContent": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandEmailContent"
      },
      "description": "Deprecated."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "landingPages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "An array of name/value pairs specifying the pages to which the user is redirected after the following events occur:\n\n- Signing Completed\n- Viewed Exit\n- Finish Later\n- Decline\n- Session Timeout\n- Authentication Failure\n\nIf you do not specify landing pages, the DocuSign default pages are used."
    },
    "brandLanguages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of two-letter codes for the languages that you want to use with the brand. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)"
    },
    "isSendingDefault": {
      "type": "boolean",
      "description": "When **true,** the sending brand is the default brand for sending new envelopes."
    },
    "isSigningDefault": {
      "type": "boolean",
      "description": "When **true,** the siging brand is the default brand for the signing experience."
    },
    "isOrganizationBrand": {
      "type": "string",
      "description": ""
    },
    "defaultBrandLanguage": {
      "type": "string",
      "description": "The two-letter code for the language that you want to use as the brand default. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)"
    },
    "organizationBrandLogo": {
      "type": "string",
      "description": ""
    },
    "isOverridingCompanyName": {
      "type": "boolean",
      "description": "When **true,** the `brandCompany` property is overriding the name of the company in the account settings."
    }
  },
  "description": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.",
  "x-ms-summary": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.",
  "x-ds-definition-name": "brand"
}

{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "description": "Deprecated."
    },
    "linkText": {
      "type": "string",
      "description": "Deprecated."
    },
    "emailToLink": {
      "type": "string",
      "description": "Deprecated."
    },
    "emailContentType": {
      "type": "string",
      "description": "Deprecated."
    }
  },
  "description": "Deprecated.",
  "x-ms-summary": "Deprecated.",
  "x-ds-definition-name": "brandEmailContent"
}

{
  "type": "object",
  "properties": {
    "linkText": {
      "type": "string",
      "description": "The text used for the link."
    },
    "linkType": {
      "type": "string",
      "description": "The type of link. Valid values include:\n\n- `aboutDocusign`\n- `closeButton`"
    },
    "showLink": {
      "type": "string",
      "description": "When **true,** the link displays to the recipient."
    },
    "urlOrMailTo": {
      "type": "string",
      "description": "The URL or mailto address of the link."
    }
  },
  "description": "Information about a link that a brand uses.",
  "x-ms-summary": "Information about a link that a brand uses.",
  "x-ds-definition-name": "brandLink"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n"
    },
    "primary": {
      "type": "string",
      "description": "The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n"
    },
    "secondary": {
      "type": "string",
      "description": "The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n"
    }
  },
  "description": "The URIs for retrieving the logos that are associated with the brand.\n\nThese are read-only properties that provide a URI to logos in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n",
  "x-ms-summary": "The URIs for retrieving the logos that are associated with the brand.\n\nThese are read-only properties that provide a URI to logos in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n",
  "x-ds-definition-name": "brandLogos"
}

{
  "type": "object",
  "properties": {
    "brandId": {
      "type": "string",
      "description": "The ID of the brand used in API calls"
    }
  },
  "description": "This request object contains information about a specific brand.",
  "x-ms-summary": "This request object contains information about a specific brand.",
  "x-ds-definition-name": "brandRequest"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The URI for the email resource file that the brand uses."
    },
    "sending": {
      "type": "string",
      "description": "The URI for the sending resource file that the brand uses."
    },
    "signing": {
      "type": "string",
      "description": "The URI for the signing resource file that the brand uses."
    },
    "signingCaptive": {
      "type": "string",
      "description": "The URI for the captive (embedded) signing resource file that the brand uses."
    }
  },
  "description": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.",
  "x-ms-summary": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.",
  "x-ds-definition-name": "brandResourceUrls"
}

{
  "type": "object",
  "properties": {
    "createdDate": {
      "type": "string",
      "description": "The date and time that the brand resource was created."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The date on which this user record was last modified."
    },
    "createdByUserInfo": {
      "$ref": "#/components/schemas/userInfo"
    },
    "modifiedTemplates": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files.\n\n[listResources]: /docs/esign-rest-api/reference/accounts/accountbrands/listresources/"
    },
    "modifiedByUserInfo": {
      "$ref": "#/components/schemas/userInfo"
    },
    "resourcesContentUri": {
      "type": "string",
      "description": "The URI for the brand resource file."
    },
    "resourcesContentType": {
      "type": "string",
      "description": "The type of brand resource file. A brand uses a different resource file to control each of the following experiences:\n\n- Sending (`sending`)\n- Signing (`signing`)\n- Email messages (`email`)\n- Captive (embedded) signing (`signing_captive`)\n\nYou can modify the default email messages and formats in these files and upload them to your brand to customize the user experience."
    },
    "dataNotSavedNotInMaster": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Deprecated."
    }
  },
  "description": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.",
  "x-ms-summary": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.",
  "x-ds-definition-name": "brandResources"
}

{
  "type": "object",
  "properties": {
    "resourcesContentTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandResources"
      },
      "description": "A list of resources that the brand uses."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "brandResourcesList"
}

{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandRequest"
      },
      "description": "A list of brands."
    }
  },
  "description": "Details about one or more brands.",
  "x-ms-summary": "Details about one or more brands.",
  "x-ds-definition-name": "brandsRequest"
}

{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brand"
      },
      "description": "A list of brands."
    },
    "senderBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope senders see when a brand is not explicitly set."
    },
    "recipientBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope recipients see when a brand is not explicitly set."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "brandsResponse"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the recipient assigned to this envelope transaction."
    },
    "email": {
      "type": "string",
      "description": "The email address of the recipient assigned to this envelope transaction."
    },
    "bulkStatus": {
      "type": "string",
      "description": "Indicates the status of the bulk send operation. Returned values can be:\n- `queued`\n- `processing`\n- `sent`\n- `failed`"
    },
    "envelopeId": {
      "type": "string",
      "description": "GUID of the bulk envelope."
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "transactionId": {
      "type": "string",
      "description": "Identifier for the envelope transaction. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. DocuSign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transaction ID to determine an envelope's status (queued, processing, sent, or failed) in cases where the Internet connection is lost before envelope status is returned."
    },
    "bulkRecipientRow": {
      "type": "string",
      "description": "The row of the recipient in the CSV file used to create the bulk recipient list."
    },
    "submittedDateTime": {
      "type": "string",
      "description": "The date and time on which the bulk envelope was created."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkEnvelope"
}

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "string",
      "description": "The number of entries with a status of sent."
    },
    "failed": {
      "type": "string",
      "description": "The number of entries with a status of failed. "
    },
    "queued": {
      "type": "string",
      "description": "The number of entries with a status of queued. "
    },
    "batchId": {
      "type": "string",
      "description": "Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches."
    },
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "batchSize": {
      "type": "string",
      "description": "The number of items returned in this response."
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "bulkEnvelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkEnvelope"
      },
      "description": "A list of bulk envelope objects."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    },
    "submittedDate": {
      "type": "string",
      "description": "The date on which the bulk envelope was created."
    },
    "bulkEnvelopesBatchUri": {
      "type": "string",
      "description": "URI at which you can retrieve the batch envelopes."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkEnvelopeStatus"
}

{
  "type": "object",
  "properties": {
    "batchName": {
      "type": "string",
      "description": ""
    },
    "envelopeOrTemplateId": {
      "type": "string",
      "description": "The GUID of the envelope or template."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessRequest"
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "batchId": {
      "type": "string",
      "description": "Identifier used to query the status of an individual bulk recipient batch."
    },
    "batchName": {
      "type": "string",
      "description": ""
    },
    "batchSize": {
      "type": "string",
      "description": "The total number of items in the batch being queried."
    },
    "queueLimit": {
      "type": "string",
      "description": ""
    },
    "totalQueued": {
      "type": "string",
      "description": ""
    },
    "errorDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Error details.\n"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessResponse"
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendBatchError"
      },
      "description": ""
    },
    "listId": {
      "type": "string",
      "description": "The GUID of the bulk send list."
    },
    "success": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessResult"
}

{
  "type": "object",
  "properties": {
    "bulkListSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkProcessingListSummary"
      },
      "description": "An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessingListSummaries"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "createdByUser": {
      "type": "string",
      "description": ""
    },
    "bulkProcessListId": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessingListSummary"
}

{
  "type": "object",
  "properties": {
    "bulkProcessListIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessingLists"
}

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to apply. Valid values:\n\n* `Resend`\n* `Correct`\n* `Void`\n\nThis property is required and case-sensitive. The value must correspond to the `bulkAction` query parameter.\n"
    },
    "voidReason": {
      "type": "string",
      "description": "A string explaining why the envelope is voided. This value is shown in a message to the recipients.\n\nThis property is required if `action` is `Void`.\n"
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendBatchActionRequest"
}

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "The server error associated with the Connect post failure."
    },
    "errorDetail": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendBatchError"
}

{
  "type": "object",
  "properties": {
    "batchName": {
      "type": "string",
      "description": "The new name of the bulk send batch.\n\nThis property is required. The maximum length of the string is 500 characters."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendBatchRequest"
}