swagger: '2.0'
info:
  title: Abuse Actions v1 API
  version: 2.0.0
  description: <strong>GoDaddy Abuse API Terms of Use:</strong><p>GoDaddy’s Abuse API is provided to simplify and standardize the abuse reporting experience. To help us streamline the review of abuse reports, you acknowledge and agree that your use of GoDaddy’s Abuse API is subject to the following quality metrics and terms of use.</p><p>GoDaddy may, in its sole and absolute discretion, change or modify these terms, and such changes or modifications shall be effective immediately upon notice to you. Your use of GoDaddy’s Abuse API after such changes or modifications shall constitute your acceptance of these terms as last revised. If you do not agree to be bound by these terms as last revised, do not use (or continue to use) our Abuse API.</p><p>As an Abuse API user, you must only submit abuse reports via the API portal and cease all email submissions, including but not limited, to phishing@godaddy.com, netabuse@godaddy.com, malware@godaddy.com, or spam@godaddy.com, etc.  Any additional or duplicate submission outside of the API portal will be deprioritized for review. Submissions related to trademark, copyright or content issues may still be sent to trademarkclaims@godaddy.com, coyprightclaims@godaddy.com, and contentcomplaints@godaddy.com, respectively. Our [Front of Site](https://supportcenter.godaddy.com/AbuseReport) also describes other scenarios not covered by the API.</p><p>When you submit abuse reports via GoDaddy’s Abuse API, you must ensure that you accurately categorize the abuse type of each report to match our definitions in the API documentations provided to you. Any submission that fails to match our definitions or is miscategorized will be marked as a false positive. Examples include, but are not limited to, submissions of trademark complaints marked as phishing or malware, or submissions of copyright complaints marked as phishing or malware, etc.</p><p>If, at any time, the false positive rate of submissions exceeds 40% of your total submissions, as determined by GoDaddy, GoDaddy may in its sole discretion deprioritize any subsequent reports submitted by you and/or your organization.</p><p>You acknowledge and agree that submitting every URL for a single domain is not necessary and will not expedite the review process. If your submissions exceed five (5) URLs for a single domain, your report will be marked as a duplicate submission taking into account that the final outcome of such submissions would yield the same result as the original report. GoDaddy may in its sole discretion deprioritize reports submitted by you and/or your organization in the event more than 20% of your submissions are classified as duplicate submissions.</p><p>You further acknowledge and agree that our Customer Support lines are not intended to address abuse reporting matters or your use of GoDaddy’s Abuse API. Contacting Customer Support will not expedite the review process and may result in abuse reports being deprioritized, to be determined in our sole discretion.</p><p>Should you have any questions about GoDaddy’s Abuse API or any of the terms and conditions set forth above, please contact abuseapisupport@godaddy.com.</p>
host: api.ote-godaddy.com
tags:
- name: v1
  description: ''
paths:
  /v1/abuse/tickets:
    get:
      tags:
      - v1
      parameters:
      - description: The type of abuse.
        enum:
        - A_RECORD
        - CHILD_ABUSE
        - CONTENT
        - FRAUD_WIRE
        - IP_BLOCK
        - MALWARE
        - NETWORK_ABUSE
        - PHISHING
        - SPAM
        in: query
        name: type
        required: false
        type: string
      - default: false
        description: Is this abuse ticket closed?
        in: query
        name: closed
        required: false
        type: boolean
      - description: The domain name or ip address the abuse originated from
        format: host-name-or-ip-address
        in: query
        name: sourceDomainOrIp
        required: false
        type: string
      - description: 'The brand/company the abuse is targeting. ie: brand name/bank name'
        in: query
        name: target
        required: false
        type: string
      - description: The earliest abuse ticket creation date to pull abuse tickets for
        format: iso-datetime
        in: query
        name: createdStart
        required: false
        type: string
      - description: The latest abuse ticket creation date to pull abuse tickets for
        format: iso-datetime
        in: query
        name: createdEnd
        required: false
        type: string
      - default: 100
        description: Number of abuse ticket numbers to return.
        format: integer-positive
        in: query
        maximum: 100
        name: limit
        required: false
        type: integer
      - default: 0
        description: The earliest result set record number to pull abuse tickets for
        format: integer-positive
        in: query
        name: offset
        required: false
        type: integer
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AbuseTicketList'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error'
        '422':
          description: Error
          schema:
            $ref: '#/definitions/Error'
      operationId: getTickets
      summary: List all abuse tickets ids that match user provided filters
    post:
      tags:
      - v1
      parameters:
      - description: The endpoint which allows the Reporter to create a new abuse ticket
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/AbuseTicketCreateLegacy'
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/AbuseTicketId'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error'
        '422':
          description: Error
          schema:
            $ref: '#/definitions/Error'
      operationId: createTicket
      summary: Create a new abuse ticket
  /v1/abuse/tickets/{ticketId}:
    get:
      tags:
      - v1
      parameters:
      - description: A unique abuse ticket identifier
        in: path
        name: ticketId
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AbuseTicketLegacy'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Invalid ticket id provided
          schema:
            $ref: '#/definitions/Error'
      operationId: getTicketInfo
      summary: Return the abuse ticket data for a given ticket id
  /v1/agreements:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: PrivateLabelId to operate as, if different from JWT
        in: header
        name: X-Private-Label-Id
        required: false
        type: integer
      - default: en-US
        description: Unique identifier of the Market used to retrieve/translate Legal Agreements
        format: bcp-47
        in: header
        name: X-Market-Id
        required: false
        type: string
      - description: Keys for Agreements whose details are to be retrieved
        in: query
        items:
          type: string
        name: keys
        required: true
        type: array
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/LegalAgreement'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_2'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_2'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_2'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_2'
      operationId: get
      summary: Retrieve Legal Agreements for provided agreements keys
  /v1/certificates:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - default: Default locale for shopper account
        description: Setting locale for communications such as emails and error messages
        in: header
        name: X-Market-Id
        required: false
        type: string
      - description: The certificate order information
        in: body
        name: certificateCreate
        required: true
        schema:
          $ref: '#/definitions/CertificateCreate'
      responses:
        '202':
          description: Request was successful
          schema:
            $ref: '#/definitions/CertificateIdentifier'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow renew
          schema:
            $ref: '#/definitions/Error_3'
        '422':
          description: '`email` is not empty<br>`csr` is invalid'
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: '<p>Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see ''/v1/certificates/{certificateId}/callback''.</p>'
      operationId: certificate_create
      summary: Create a pending order for certificate
  /v1/certificates/validate:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - default: Default locale for shopper account
        description: Setting locale for communications such as emails and error messages
        in: header
        name: X-Market-Id
        required: false
        type: string
      - description: The certificate order info
        in: body
        name: certificateCreate
        required: true
        schema:
          $ref: '#/definitions/CertificateCreate'
      responses:
        '204':
          description: Request validated successfully
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow renew
          schema:
            $ref: '#/definitions/Error_3'
        '422':
          description: '`email` is not empty <br> `csr` is invalid'
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      operationId: certificate_validate
      summary: Validate a pending order for certificate
  /v1/certificates/{certificateId}:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to lookup
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '200':
          description: Certificate details retrieved
          schema:
            $ref: '#/definitions/Certificate'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate.
      operationId: certificate_get
      summary: Retrieve certificate details
  /v1/certificates/{certificateId}/actions:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to register for callback
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '200':
          description: Action retrieval successful
          schema:
            $ref: '#/definitions/ArrayOfCertificateAction'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method is used to retrieve all stateful actions relating to a certificate lifecycle.
      operationId: certificate_action_retrieve
      summary: Retrieve all certificate actions
  /v1/certificates/{certificateId}/email/{emailId}/resend:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to resend email
        in: path
        name: certificateId
        required: true
        type: string
      - description: Email id for email to resend
        in: path
        name: emailId
        required: true
        type: string
      responses:
        '204':
          description: Email sent successfully
        '404':
          description: Certificate not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Email Id not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method can be used to resend emails by providing the certificate id and the email id
      operationId: certificate_resend_email
      summary: Resend an email
  /v1/certificates/{certificateId}/email/resend/{emailAddress}:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to resend emails
        in: path
        name: certificateId
        required: true
        type: string
      - description: Specific email address to resend email
        in: path
        name: emailAddress
        required: true
        type: string
      responses:
        '200':
          description: Alternate email address added and emails re-sent
          schema:
            $ref: '#/definitions/CertificateEmailHistory'
        '404':
          description: Certificate not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow alternate email address
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address.
      operationId: certificate_alternate_email_address
      summary: Add alternate email address
  /v1/certificates/{certificateId}/email/{emailId}/resend/{emailAddress}:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to resend emails
        in: path
        name: certificateId
        required: true
        type: string
      - description: Email id for email to resend
        in: path
        name: emailId
        required: true
        type: string
      - description: Specific email address to resend email
        in: path
        name: emailAddress
        required: true
        type: string
      responses:
        '204':
          description: Email sent successfully
        '404':
          description: Certificate not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Email Id not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address
      operationId: certificate_resend_email_address
      summary: Resend email to email address
  /v1/certificates/{certificateId}/email/history:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to retrieve email history
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '200':
          description: Email history retrieval successful
          schema:
            $ref: '#/definitions/CertificateEmailHistory'
        '409':
          description: Email history not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method can be used to retrieve all emails sent for a certificate.
      operationId: certificate_email_history
      summary: Retrieve email history
  /v1/certificates/{certificateId}/callback:
    delete:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to unregister callback
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '204':
          description: Callback removed
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: Unregister the callback for a particular certificate.
      operationId: certificate_callback_delete
      summary: Unregister system callback
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to register for stateful action callback
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '200':
          description: Callback registered
          schema:
            $ref: '#/definitions/CertificateCallback'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method is used to retrieve the registered callback url for a certificate.
      operationId: certificate_callback_get
      summary: Retrieve system stateful action callback url
    put:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to register/replace for callback
        in: path
        name: certificateId
        required: true
        type: string
      - description: Callback url registered/replaced to receive stateful actions
        in: query
        name: callbackUrl
        required: true
        type: string
      responses:
        '204':
          description: Callback replaced/registered
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '422':
          description: Callback url is missing <br> Callback url is malformed
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action.  Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration.
      operationId: certificate_callback_replace
      summary: Register of certificate action callback
  /v1/certificates/{certificateId}/cancel:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to cancel
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '204':
          description: Certificate order has been canceled
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow cancel
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: Use the cancel call to cancel a pending certificate order.
      operationId: certificate_cancel
      summary: Cancel a pending certificate
  /v1/certificates/{certificateId}/download:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to download
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '200':
          description: Certificate retrieved
          schema:
            $ref: '#/definitions/CertificateBundle'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow download
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      operationId: certificate_download
      summary: Download certificate
  /v1/certificates/{certificateId}/reissue:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to reissue
        in: path
        name: certificateId
        required: true
        type: string
      - description: The reissue request info
        in: body
        name: reissueCreate
        required: true
        schema:
          $ref: '#/definitions/CertificateReissue'
      responses:
        '202':
          description: Reissue request created
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow reissue
          schema:
            $ref: '#/definitions/Error_3'
        '422':
          description: '`csr` is invalid<br>Delay revocation exceeds maximum'
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: <p>Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of the common name may take additional time to validate. If this API call is made before a previous pending reissue has been validated and issued, the previous reissue request is automatically rejected and replaced with the current request.</p>
      operationId: certificate_reissue
      summary: Reissue active certificate
  /v1/certificates/{certificateId}/renew:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to renew
        in: path
        name: certificateId
        required: true
        type: string
      - description: The renew request info
        in: body
        name: renewCreate
        required: true
        schema:
          $ref: '#/definitions/CertificateRenew'
      responses:
        '202':
          description: Renew request created
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow renew
          schema:
            $ref: '#/definitions/Error_3'
        '422':
          description: '`csr` is invalid'
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the subject alternative names you expect in the renewed certificate. New names added to a certificate that do not share the base domain of the common name may take additional time to validate. </p>
      operationId: certificate_renew
      summary: Renew active certificate
  /v1/certificates/{certificateId}/revoke:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to revoke
        in: path
        name: certificateId
        required: true
        type: string
      - description: The certificate revocation request
        in: body
        name: certificateRevoke
        required: true
        schema:
          $ref: '#/definitions/CertificateRevoke'
      responses:
        '204':
          description: Certificate Revoked
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow revoke
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned.
      operationId: certificate_revoke
      summary: Revoke active certificate
  /v1/certificates/{certificateId}/siteSeal:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id
        in: path
        name: certificateId
        required: true
        type: string
      - default: LIGHT
        description: This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present.
        enum:
        - DARK
        - LIGHT
        in: query
        name: theme
        required: false
        type: string
      - default: en
        description: Determine locale for text displayed in seal image and verification page. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present.
        in: query
        name: locale
        required: false
        type: string
      responses:
        '200':
          description: Site seal retrieved
          schema:
            $ref: '#/definitions/CertificateSiteSeal'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Certificate state does not allow seal
          schema:
            $ref: '#/definitions/Error_3'
        '422':
          description: '''locale'' is invalid'
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: <p>This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted on the reseller's website, to minimize delays for customer page load times.</p>
      operationId: certificate_siteseal_get
      summary: Get Site seal
  /v1/certificates/{certificateId}/verifyDomainControl:
    post:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Certificate id to lookup
        in: path
        name: certificateId
        required: true
        type: string
      responses:
        '204':
          description: Domain control was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_3'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_3'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_3'
        '404':
          description: Certificate id not found
          schema:
            $ref: '#/definitions/Error_3'
        '409':
          description: Domain control was not successful <br> Certificate state does not allow domain control
          schema:
            $ref: '#/definitions/Error_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_3'
      description: Domain control is a means for verifying the domain included in the certificate order. This resource is useful for resellers that control the domains for their customers, and can expedite the verification process. See https://www.godaddy.com/help/verifying-your-domain-ownership-for-ssl-certificate-requests-html-or-dns-7452
      operationId: certificate_verifydomaincontrol
      summary: Check Domain Control
  /v1/countries:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: MarketId in which the request is being made, and for which responses should be localized
        format: bcp-47
        in: query
        name: marketId
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ArrayOfCountrySummary'
        '422':
          description: marketId is required
          schema:
            $ref: '#/definitions/Error_4'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_2'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_4'
      description: Authorization is not required
      operationId: getCountries
      summary: Retrieves summary country information for the provided marketId and filters
  /v1/countries/{countryKey}:
    get:
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: The country key
        format: iso-country-code
        in: path
        name: countryKey
        required: true
        type: string
      - description: MarketId in which the request is being made, and for which responses should be localized
        format: bcp-47
        in: query
        name: marketId
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ArrayOfCountry'
        '404':
          description: Country not found
          schema:
            $ref: '#/definitions/Error_4'
        '422':
          description: marketId is required
          schema:
            $ref: '#/definitions/Error_4'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_2'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_4'
      description: Authorization is not required
      operationId: getCountry
      summary: Retrieves country and summary state information for provided countryKey
  /v1/domains:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Shopper ID whose domains are to be retrieved
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Only include results with `status` value in the specified set
        in: query
        items:
          enum:
          - ACTIVE
          - AWAITING_CLAIM_ACK
          - AWAITING_DOCUMENT_AFTER_TRANSFER
          - AWAITING_DOCUMENT_AFTER_UPDATE_ACCOUNT
          - AWAITING_DOCUMENT_UPLOAD
          - AWAITING_FAILED_TRANSFER_WHOIS_PRIVACY
          - AWAITING_PAYMENT
          - AWAITING_RENEWAL_TRANSFER_IN_COMPLETE
          - AWAITING_TRANSFER_IN_ACK
          - AWAITING_TRANSFER_IN_AUTH
          - AWAITING_TRANSFER_IN_AUTO
          - AWAITING_TRANSFER_IN_WHOIS
          - AWAITING_TRANSFER_IN_WHOIS_FIX
          - AWAITING_VERIFICATION_ICANN
          - AWAITING_VERIFICATION_ICANN_MANUAL
          - CANCELLED
          - CANCELLED_HELD
          - CANCELLED_REDEEMABLE
          - CANCELLED_TRANSFER
          - CONFISCATED
          - DISABLED_SPECIAL
          - EXCLUDED_INVALID_CLAIM_FIREHOSE
          - EXPIRED_REASSIGNED
          - FAILED_BACKORDER_CAPTURE
          - FAILED_DROP_IMMEDIATE_THEN_ADD
          - FAILED_PRE_REGISTRATION
          - FAILED_REDEMPTION
          - FAILED_REDEMPTION_REPORT
          - FAILED_REGISTRATION
          - FAILED_REGISTRATION_FIREHOSE
          - FAILED_RESTORATION_REDEMPTION_MOCK
          - FAILED_SETUP
          - FAILED_TRANSFER_IN
          - FAILED_TRANSFER_IN_BAD_STATUS
          - FAILED_TRANSFER_IN_REGISTRY
          - HELD_COURT_ORDERED
          - HELD_DISPUTED
          - HELD_EXPIRATION_PROTECTION
          - HELD_EXPIRED_REDEMPTION_MOCK
          - HELD_REGISTRAR_ADD
          - HELD_REGISTRAR_REMOVE
          - HELD_SHOPPER
          - HELD_TEMPORARY
          - LOCKED_ABUSE
          - LOCKED_COPYRIGHT
          - LOCKED_REGISTRY
          - LOCKED_SUPER
          - PARKED_AND_HELD
          - PARKED_EXPIRED
          - PARKED_VERIFICATION_ICANN
          - PENDING_ABORT_CANCEL_SETUP
          - PENDING_AGREEMENT_PRE_REGISTRATION
          - PENDING_APPLY_RENEWAL_CREDITS
          - PENDING_BACKORDER_CAPTURE
          - PENDING_BLOCKED_REGISTRY
          - PENDING_CANCEL_REGISTRANT_PROFILE
          - PENDING_COMPLETE_REDEMPTION_WITHOUT_RECEIPT
          - PENDING_COMPLETE_REGISTRANT_PROFILE
          - PENDING_COO
          - PENDING_COO_COMPLETE
          - PENDING_DNS
          - PENDING_DNS_ACTIVE
          - PENDING_DNS_INACTIVE
          - PENDING_DOCUMENT_VALIDATION
          - PENDING_DOCUMENT_VERIFICATION
          - PENDING_DROP_IMMEDIATE
          - PENDING_DROP_IMMEDIATE_THEN_ADD
          - PENDING_EPP_CREATE
          - PENDING_EPP_DELETE
          - PENDING_EPP_UPDATE
          - PENDING_ESCALATION_REGISTRY
          - PENDING_EXPIRATION
          - PENDING_EXPIRATION_RESPONSE
          - PENDING_EXPIRATION_SYNC
          - PENDING_EXPIRED_REASSIGNMENT
          - PENDING_EXPIRE_AUTO_ADD
          - PENDING_EXTEND_REGISTRANT_PROFILE
          - PENDING_FAILED_COO
          - PENDING_FAILED_EPP_CREATE
          - PENDING_FAILED_HELD
          - PENDING_FAILED_PURCHASE_PREMIUM
          - PENDING_FAILED_RECONCILE_FIREHOSE
          - PENDING_FAILED_REDEMPTION_WITHOUT_RECEIPT
          - PENDING_FAILED_RELEASE_PREMIUM
          - PENDING_FAILED_RENEW_EXPIRATION_PROTECTION
          - PENDING_FAILED_RESERVE_PREMIUM
          - PENDING_FAILED_SUBMIT_FIREHOSE
          - PENDING_FAILED_TRANSFER_ACK_PREMIUM
          - PENDING_FAILED_TRANSFER_IN_ACK_PREMIUM
          - PENDING_FAILED_TRANSFER_IN_PREMIUM
          - PENDING_FAILED_TRANSFER_PREMIUM
          - PENDING_FAILED_TRANSFER_SUBMIT_PREMIUM
          - PENDING_FAILED_UNLOCK_PREMIUM
          - PENDING_FAILED_UPDATE_API
          - PENDING_FRAUD_VERIFICATION
          - PENDING_FRAUD_VERIFIED
          - PENDING_GET_CONTACTS
          - PENDING_GET_HOSTS
          - PENDING_GET_NAME_SERVERS
          - PENDING_GET_STATUS
          - PENDING_HOLD_ESCROW
          - PENDING_HOLD_REDEMPTION
          - PENDING_LOCK_CLIENT_REMOVE
          - PENDING_LOCK_DATA_QUALITY
          - PENDING_LOCK_THEN_HOLD_REDEMPTION
          - PENDING_PARKING_DETERMINATION
          - PENDING_PARK_INVALID_WHOIS
          - PENDING_PARK_INVALID_WHOIS_REMOVAL
          - PENDING_PURCHASE_PREMIUM
          - PENDING_RECONCILE
          - PENDING_RECONCILE_FIREHOSE
          - PENDING_REDEMPTION
          - PENDING_REDEMPTION_REPORT
          - PENDING_REDEMPTION_REPORT_COMPLETE
          - PENDING_REDEMPTION_REPORT_SUBMITTED
          - PENDING_REDEMPTION_WITHOUT_RECEIPT
          - PENDING_REDEMPTION_WITHOUT_RECEIPT_MOCK
          - PENDING_RELEASE_PREMIUM
          - PENDING_REMOVAL
          - PENDING_REMOVAL_HELD
          - PENDING_REMOVAL_PARKED
          - PENDING_REMOVAL_UNPARK
          - PENDING_RENEWAL
          - PENDING_RENEW_EXPIRATION_PROTECTION
          - PENDING_RENEW_INFINITE
          - PENDING_RENEW_LOCKED
          - PENDING_RENEW_WITHOUT_RECEIPT
          - PENDING_REPORT_REDEMPTION_WITHOUT_RECEIPT
          - PENDING_RESERVE_PREMIUM
          - PENDING_RESET_VERIFICATION_ICANN
          - PENDING_RESPONSE_FIREHOSE
          - PENDING_RESTORATION
          - PENDING_RESTORATION_INACTIVE
          - PENDING_RESTORATION_REDEMPTION_MOCK
          - PENDING_RETRY_EPP_CREATE
          - PENDING_RETRY_HELD
          - PENDING_SEND_AUTH_CODE
          - PENDING_SETUP
          - PENDING_SETUP_ABANDON
          - PENDING_SETUP_AGREEMENT_LANDRUSH
          - PENDING_SETUP_AGREEMENT_SUNRISE2_A
          - PENDING_SETUP_AGREEMENT_SUNRISE2_B
          - PENDING_SETUP_AGREEMENT_SUNRISE2_C
          - PENDING_SETUP_AUTH
          - PENDING_SETUP_DNS
          - PENDING_SETUP_FAILED
          - PENDING_SETUP_REVIEW
          - PENDING_SETUP_SUNRISE
          - PENDING_SETUP_SUNRISE_PRE
          - PENDING_SETUP_SUNRISE_RESPONSE
          - PENDING_SUBMIT_FAILURE
          - PENDING_SUBMIT_FIREHOSE
          - PENDING_SUBMIT_HOLD_FIREHOSE
          - PENDING_SUBMIT_HOLD_LANDRUSH
          - PENDING_SUBMIT_HOLD_SUNRISE
          - PENDING_SUBMIT_LANDRUSH
          - PENDING_SUBMIT_RESPONSE_FIREHOSE
          - PENDING_SUBMIT_RESPONSE_LANDRUSH
          - PENDING_SUBMIT_RESPONSE_SUNRISE
          - PENDING_SUBMIT_SUCCESS_FIREHOSE
          - PENDING_SUBMIT_SUCCESS_LANDRUSH
          - PENDING_SUBMIT_SUCCESS_SUNRISE
          - PENDING_SUBMIT_SUNRISE
          - PENDING_SUBMIT_WAITING_LANDRUSH
          - PENDING_SUCCESS_PRE_REGISTRATION
          - PENDING_SUSPENDED_DATA_QUALITY
          - PENDING_TRANSFER_ACK_PREMIUM
          - PENDING_TRANSFER_IN
          - PENDING_TRANSFER_IN_ACK
          - PENDING_TRANSFER_IN_ACK_PREMIUM
          - PENDING_TRANSFER_IN_BAD_REGISTRANT
          - PENDING_TRANSFER_IN_CANCEL
          - PENDING_TRANSFER_IN_CANCEL_REGISTRY
          - PENDING_TRANSFER_IN_COMPLETE_ACK
          - PENDING_TRANSFER_IN_DELETE
          - PENDING_TRANSFER_IN_LOCK
          - PENDING_TRANSFER_IN_NACK
          - PENDING_TRANSFER_IN_NOTIFICATION
          - PENDING_TRANSFER_IN_PREMIUM
          - PENDING_TRANSFER_IN_RELEASE
          - PENDING_TRANSFER_IN_RESPONSE
          - PENDING_TRANSFER_IN_UNDERAGE
          - PENDING_TRANSFER_OUT
          - PENDING_TRANSFER_OUT_ACK
          - PENDING_TRANSFER_OUT_NACK
          - PENDING_TRANSFER_OUT_PREMIUM
          - PENDING_TRANSFER_OUT_UNDERAGE
          - PENDING_TRANSFER_OUT_VALIDATION
          - PENDING_TRANSFER_PREMIUM
          - PENDING_TRANSFER_PREMUIM
          - PENDING_TRANSFER_SUBMIT_PREMIUM
          - PENDING_UNLOCK_DATA_QUALITY
          - PENDING_UNLOCK_PREMIUM
          - PENDING_UPDATE
          - PENDING_UPDATED_REGISTRANT_DATA_QUALITY
          - PENDING_UPDATE_ACCOUNT
          - PENDING_UPDATE_API
          - PENDING_UPDATE_API_RESPONSE
          - PENDING_UPDATE_AUTH
          - PENDING_UPDATE_CONTACTS
          - PENDING_UPDATE_CONTACTS_PRIVACY
          - PENDING_UPDATE_DNS
          - PENDING_UPDATE_DNS_SECURITY
          - PENDING_UPDATE_ELIGIBILITY
          - PENDING_UPDATE_EPP_CONTACTS
          - PENDING_UPDATE_MEMBERSHIP
          - PENDING_UPDATE_OWNERSHIP
          - PENDING_UPDATE_OWNERSHIP_AUTH_AUCTION
          - PENDING_UPDATE_OWNERSHIP_HELD
          - PENDING_UPDATE_REGISTRANT
          - PENDING_UPDATE_REPO
          - PENDING_VALIDATION_DATA_QUALITY
          - PENDING_VERIFICATION_FRAUD
          - PENDING_VERIFICATION_STATUS
          - PENDING_VERIFY_REGISTRANT_DATA_QUALITY
          - RESERVED
          - RESERVED_PREMIUM
          - REVERTED
          - SUSPENDED_VERIFICATION_ICANN
          - TRANSFERRED_OUT
          - UNLOCKED_ABUSE
          - UNLOCKED_SUPER
          - UNPARKED_AND_UNHELD
          - UPDATED_OWNERSHIP
          - UPDATED_OWNERSHIP_HELD
          type: string
        name: statuses
        required: false
        type: array
      - description: Only include results with `status` value in any of the specified groups
        in: query
        items:
          enum:
          - INACTIVE
          - PRE_REGISTRATION
          - REDEMPTION
          - RENEWABLE
          - VERIFICATION_ICANN
          - VISIBLE
          type: string
        name: statusGroups
        required: false
        type: array
      - description: Maximum number of domains to return
        in: query
        maximum: 1000
        minimum: 1
        name: limit
        required: false
        type: integer
      - description: Marker Domain to use as the offset in results
        in: query
        name: marker
        required: false
        type: string
      - description: Optional details to be included in the response
        in: query
        items:
          enum:
          - authCode
          - contacts
          - nameServers
          type: string
        name: includes
        required: false
        type: array
      - description: Only include results that have been modified since the specified date
        format: iso-datetime
        in: query
        name: modifiedDate
        required: false
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/DomainSummary'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Limit must have a value no greater than 1000
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: list
      summary: Retrieve a list of Domains for the specified Shopper
  /v1/domains/agreements:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - default: en-US
        description: Unique identifier of the Market used to retrieve/translate Legal Agreements
        format: bcp-47
        in: header
        name: X-Market-Id
        required: false
        type: string
      - description: list of TLDs whose legal agreements are to be retrieved
        in: query
        items:
          type: string
        name: tlds
        required: true
        type: array
      - description: Whether or not privacy has been requested
        in: query
        name: privacy
        required: true
        type: boolean
      - description: Whether or not domain tranfer has been requested
        in: query
        name: forTransfer
        required: false
        type: boolean
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/LegalAgreement'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: getAgreement
      summary: Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons
  /v1/domains/available:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Domain name whose availability is to be checked
        in: query
        name: domain
        required: true
        type: string
      - default: FAST
        description: Optimize for time ('FAST') or accuracy ('FULL')
        enum:
        - FAST
        - FULL
        - fast
        - full
        in: query
        name: checkType
        required: false
        type: string
      - default: false
        description: Whether or not to include domains available for transfer. If set to True, checkType is ignored
        in: query
        name: forTransfer
        required: false
        type: boolean
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainAvailableResponse'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Cannot convert domain label error<br>Domain is missing IDN script<br>Domain segment ends with dash<br>Domain starts with dashbr>Domain uses unsupported IDN script<br>FQDN fails generic validity regex<br>Invalid character(s) error<br>Invalid tld error<br>Non-IDN domain name must not have dashes at the third and fourth position<br>Reserved name error<br>domain must be specified
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: available
      summary: Determine whether or not the specified domain is available for purchase
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Domain names for which to check availability
        in: body
        name: domains
        required: true
        schema:
          items:
            type: string
          maximum: 500
          type: array
      - default: FAST
        description: Optimize for time ('FAST') or accuracy ('FULL')
        enum:
        - FAST
        - FULL
        - fast
        - full
        in: query
        name: checkType
        required: false
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainAvailableBulk'
        '203':
          description: Request was partially successful
          schema:
            $ref: '#/definitions/DomainAvailableBulkMixed'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Cannot convert domain label error<br>Domain is missing IDN script<br>Domain segment ends with dash<br>Domain starts with dash<br>Domain uses unsupported IDN script<br>FQDN fails generic validity regex<br>Invalid character(s) error<br>Invalid tld error<br>Non-IDN domain name must not have dashes at the third and fourth position<br>Reserved name error<br>Reserved name error<br>domain must be specified
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: availableBulk
      summary: Determine whether or not the specified domains are available for purchase
  /v1/domains/contacts/validate:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - default: 1
        description: PrivateLabelId to operate as, if different from JWT
        in: header
        name: X-Private-Label-Id
        required: false
        type: integer
      - default: en-US
        description: MarketId in which the request is being made, and for which responses should be localized
        format: bcp-47
        in: query
        name: marketId
        required: false
        type: string
      - description: An instance document expected for domains contacts validation
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DomainsContactsBulk'
      responses:
        '200':
          description: No response was specified
        '204':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Request body doesn't fulfill schema, see details in `fields`
          schema:
            $ref: '#/definitions/ErrorDomainContactsValidate'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      description: All contacts specified in request will be validated against all domains specifed in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names
      operationId: ContactsValidate
      summary: Validate the request body using the Domain Contact Validation Schema for specified domains.
  /v1/domains/purchase:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: The Shopper for whom the domain should be purchased
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: An instance document expected to match the JSON schema returned by `./schema/{tld}`
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DomainPurchase'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainPurchaseResponse'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: domain must be specified<br>Based on restrictions declared in JSON schema returned by `./schema/{tld}`<br>Cannot convert domain label error<br>Domain is missing IDN script<br>Domain segment ends with dash<br>Domain starts with dash<br>Domain uses unsupported IDN script<br>FQDN fails generic validity regex<br>Invalid character(s) error<br>Invalid tld error<br>Non-IDN domain name must not have dashes at the third and fourth position<br>Reserved name error<br>`body` must be specified
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: purchase
      summary: Purchase and register the specified Domain
  /v1/domains/purchase/schema/{tld}:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: The Top-Level Domain whose schema should be retrieved
        in: path
        name: tld
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/JsonSchema'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`tld` must be specified'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: schema
      summary: Retrieve the schema to be submitted when registering a Domain for the specified TLD
  /v1/domains/purchase/validate:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: An instance document expected to match the JSON schema returned by `./schema/{tld}`
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DomainPurchase'
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Based on restrictions declared in JSON schema returned by `./schema/{tld}`
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: validate
      summary: Validate the request body using the Domain Purchase Schema for the specified TLD
  /v1/domains/suggest:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Shopper ID for which the suggestions are being generated
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain name or set of keywords for which alternative domain names will be suggested
        in: query
        name: query
        required: false
        type: string
      - description: 'Two-letter ISO country code to be used as a hint for target region<br/><br/>

          NOTE: These are sample values, there are many

          <a href="http://www.iso.org/iso/country_codes.htm">more</a>'
        enum:
        - AC
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AO
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AX
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BM
        - BN
        - BO
        - BQ
        - BR
        - BS
        - BT
        - BV
        - BW
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CR
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DE
        - DJ
        - DK
        - DM
        - DO
        - DZ
        - EC
        - EE
        - EG
        - EH
        - ER
        - ES
        - ET
        - FI
        - FJ
        - FK
        - FM
        - FO
        - FR
        - GA
        - GB
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IS
        - IT
        - JE
        - JM
        - JO
        - JP
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KR
        - KV
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MG
        - MH
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NI
        - NL
        - 'NO'
        - NP
        - NR
        - NU
        - NZ
        - OM
        - PA
        - PE
        - PF
        - PG
        - PH
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PW
        - PY
        - QA
        - RE
        - RO
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SE
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - ST
        - SV
        - SX
        - SZ
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TP
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UM
        - US
        - UY
        - UZ
        - VA
        - VC
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WS
        - YE
        - YT
        - ZA
        - ZM
        - ZW
        format: iso-country-code
        in: query
        name: country
        required: false
        type: string
      - description: Name of city to be used as a hint for target region
        format: city-name
        in: query
        name: city
        required: false
        type: string
      - description: 'Sources to be queried<br/><br/><ul>

          <li><strong>CC_TLD</strong> - Varies the TLD using Country Codes</li>

          <li><strong>EXTENSION</strong> - Varies the TLD</li>

          <li><strong>KEYWORD_SPIN</strong> - Identifies keywords and then rotates each one</li>

          <li><strong>PREMIUM</strong> - Includes variations with premium prices</li></ul>'
        in: query
        items:
          enum:
          - CC_TLD
          - EXTENSION
          - KEYWORD_SPIN
          - PREMIUM
          - cctld
          - extension
          - keywordspin
          - premium
          type: string
        name: sources
        required: false
        type: array
      - description: 'Top-level domains to be included in suggestions<br/><br/>

          NOTE: These are sample values, there are many

          <a href="http://www.godaddy.com/tlds/gtld.aspx#domain_search_form">more</a>'
        in: query
        items:
          type: string
        name: tlds
        required: false
        type: array
      - description: Maximum length of second-level domain
        in: query
        name: lengthMax
        required: false
        type: integer
      - description: Minimum length of second-level domain
        in: query
        name: lengthMin
        required: false
        type: integer
      - description: Maximum number of suggestions to return
        in: query
        name: limit
        required: false
        type: integer
      - default: 1000
        description: 'Maximum amount of time, in milliseconds, to wait for responses

          If elapses, return the results compiled up to that point'
        format: integer-positive
        in: query
        name: waitMs
        required: false
        type: integer
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/DomainSuggestion'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`query` must be specified'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: suggest
      summary: Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history
  /v1/domains/tlds:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/TldSummary'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: tlds
      summary: Retrieves a list of TLDs supported and enabled for sale
  /v1/domains/{domain}:
    delete:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Domain to cancel
        in: path
        name: domain
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: The domain does not exist
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Unknown domain error<br>At least two apex (aka @) `nameServers` must be specified
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: cancel
      summary: Cancel a purchased domain
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Shopper ID expected to own the specified domain
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain name whose details are to be retrieved
        in: path
        name: domain
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainDetail'
        '203':
          description: Request was partially successful, see verifications.status for further detail
          schema:
            $ref: '#/definitions/DomainDetail'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`domain` must be specified'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: get
      summary: Retrieve details for the specified Domain
    patch:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Domain whose details are to be updated
        in: path
        name: domain
        required: true
        type: string
      - description: 'Shopper for whom Domain is to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Changes to apply to existing Domain
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DomainUpdate'
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Specified Subaccount not owned by authenticated Shopper
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '409':
          description: The given domain is not eligible to have its nameservers changed
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: At least two apex (aka @) `nameServers` must be specified<br>Failed to update nameservers
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: update
      summary: Update details for the specified Domain
  /v1/domains/{domain}/contacts:
    patch:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper for whom domain contacts are to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose Contacts are to be updated.
        in: path
        name: domain
        required: true
        type: string
      - description: Changes to apply to existing Contacts
        in: body
        name: contacts
        required: true
        schema:
          $ref: '#/definitions/DomainContacts'
      responses:
        '200':
          description: No response was specified
        '204':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Domain not found<br>Identity document not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`domain` is not a valid Domain name'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: updateContacts
      summary: Update domain
  /v1/domains/{domain}/privacy:
    delete:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Shopper ID of the owner of the domain
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose privacy is to be cancelled
        in: path
        name: domain
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: The domain does not exist
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Customer has purchased Domain Ownership Protection and the domain has expired<br>The domain status does not allow performing the operation<br>Unknown domain error
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: cancelPrivacy
      summary: Submit a privacy cancellation request for the given domain
  /v1/domains/{domain}/privacy/purchase:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Shopper ID of the owner of the domain
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain for which to purchase privacy
        in: path
        name: domain
        required: true
        type: string
      - description: Options for purchasing privacy
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/PrivacyPurchase'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainPurchaseResponse'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '409':
          description: The domain status does not allow performing the operation
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: End-user must read and consent to all of the following legal agreements<br>`domain` must match `sld.tld`
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: purchasePrivacy
      summary: Purchase privacy for a specified domain
  /v1/domains/{domain}/records:
    patch:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose DNS Records are to be augmented
        in: path
        name: domain
        required: true
        type: string
      - description: DNS Records to add to whatever currently exists
        in: body
        name: records
        required: true
        schema:
          $ref: '#/definitions/ArrayOfDNSRecord'
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`domain` is not a valid Domain name'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: recordAdd
      summary: Add the specified DNS Records to the specified Domain
    put:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose DNS Records are to be replaced
        in: path
        name: domain
        required: true
        type: string
      - description: DNS Records to replace whatever currently exists
        in: body
        name: records
        required: true
        schema:
          items:
            $ref: '#/definitions/DNSRecord'
          type: array
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`domain` is not a valid Domain name<br>`record` does not fulfill the schema'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: recordReplace
      summary: Replace all DNS Records for the specified Domain
  /v1/domains/{domain}/records/{type}/{name}:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose DNS Records are to be retrieved
        in: path
        name: domain
        required: true
        type: string
      - description: DNS Record Type for which DNS Records are to be retrieved
        enum:
        - A
        - AAAA
        - CNAME
        - MX
        - NS
        - SOA
        - SRV
        - TXT
        in: path
        name: type
        required: true
        type: string
      - description: DNS Record Name for which DNS Records are to be retrieved
        in: path
        name: name
        required: true
        type: string
      - description: Number of results to skip for pagination
        in: query
        name: offset
        required: false
        type: integer
      - description: Maximum number of items to return
        in: query
        name: limit
        required: false
        type: integer
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/DNSRecord'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`record` does not fulfill the schema<br>`domain` is not a valid Domain name'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: recordGet
      summary: Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name
    put:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose DNS Records are to be replaced
        in: path
        name: domain
        required: true
        type: string
      - description: DNS Record Type for which DNS Records are to be replaced
        enum:
        - A
        - AAAA
        - CNAME
        - MX
        - NS
        - SOA
        - SRV
        - TXT
        in: path
        name: type
        required: true
        type: string
      - description: DNS Record Name for which DNS Records are to be replaced
        in: path
        name: name
        required: true
        type: string
      - description: DNS Records to replace whatever currently exists
        in: body
        name: records
        required: true
        schema:
          items:
            $ref: '#/definitions/DNSRecordCreateTypeName'
          type: array
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`record` does not fulfill the schema'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: recordReplaceTypeName
      summary: Replace all DNS Records for the specified Domain with the specified Type and Name
    delete:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose DNS Records are to be deleted
        in: path
        name: domain
        required: true
        type: string
      - description: DNS Record Type for which DNS Records are to be deleted
        enum:
        - A
        - AAAA
        - CNAME
        - MX
        - SRV
        - TXT
        in: path
        name: type
        required: true
        type: string
      - description: DNS Record Name for which DNS Records are to be deleted
        in: path
        name: name
        required: true
        type: string
      responses:
        '204':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Domain not found
          schema:
            $ref: '#/definitions/Error_5'
        '409':
          description: The given domain is not eligible to have its records changed
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`domain` is not a valid Domain name'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: recordDeleteTypeName
      summary: Delete all DNS Records for the specified Domain with the specified Type and Name
  /v1/domains/{domain}/records/{type}:
    put:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose DNS Records are to be replaced
        in: path
        name: domain
        required: true
        type: string
      - description: DNS Record Type for which DNS Records are to be replaced
        enum:
        - A
        - AAAA
        - CNAME
        - MX
        - NS
        - SOA
        - SRV
        - TXT
        in: path
        name: type
        required: true
        type: string
      - description: DNS Records to replace whatever currently exists
        in: body
        name: records
        required: true
        schema:
          items:
            $ref: '#/definitions/DNSRecordCreateType'
          type: array
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`record` does not fulfill the schema'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: recordReplaceType
      summary: Replace all DNS Records for the specified Domain with the specified Type
  /v1/domains/{domain}/renew:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper for whom Domain is to be renewed. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain to renew
        in: path
        name: domain
        required: true
        type: string
      - description: Options for renewing existing Domain
        in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/DomainRenew'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainPurchaseResponse'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '409':
          description: The domain status does not allow performing the operation
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: End-user must read and consent to all of the following legal agreements<br>`domain` must match `sld.tld`
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: renew
      summary: Renew the specified Domain
  /v1/domains/{domain}/transfer:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: The Shopper to whom the domain should be transfered
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain to transfer in
        in: path
        name: domain
        required: true
        type: string
      - description: Details for domain transfer purchase
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DomainTransferIn'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DomainPurchaseResponse'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '409':
          description: '`domain` (domain) isn''t available for transfer'
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: Based on restrictions declared in JSON schema returned by `./schema/{tld}`<br>Cannot convert domain label error<br>Domain is missing IDN script<br>Domain segment ends with dash<br>Domain starts with dash<br>Domain uses unsupported IDN script<br>End-user must read and consent to all of the following legal agreements<br>FQDN fails generic validity regex<br>Invalid character(s) error<br>Invalid period range<br>Invalid tld error<br>Non-IDN domain name must not have dashes at the third and fourth position<br>Reserved name error<br>`authCode` cannot be empty<br>`domain` must match `sld.tld`<br>domain must be specified
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
      operationId: transferIn
      summary: Purchase and start or restart transfer process
  /v1/domains/{domain}/verifyRegistrantEmail:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'Shopper for whom domain contact e-mail should be verified. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you''re a Reseller, but purchased a Domain via http://www.godaddy.com'
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Domain whose Contact E-mail should be verified.
        in: path
        name: domain
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_5'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_5'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_5'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_5'
        '422':
          description: '`domain` is not a valid Domain name'
          schema:
            $ref: '#/definitions/Error_5'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_3'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_5'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_5'
      operationId: verifyEmail
      summary: Re-send Contact E-mail Verification for specified Domain
  /v1/orders:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Start of range indicating what time-frame should be returned. Inclusive
        in: query
        name: periodStart
        required: false
        type: string
      - description: End of range indicating what time-frame should be returned. Inclusive
        in: query
        name: periodEnd
        required: false
        type: string
      - description: Domain name to use as the filter of results
        in: query
        name: domain
        required: false
        type: string
      - description: Product group id to use as the filter of results
        in: query
        name: productGroupId
        required: false
        type: integer
      - description: Payment profile id to use as the filter of results
        in: query
        name: paymentProfileId
        required: false
        type: integer
      - description: Parent order id to use as the filter of results
        in: query
        name: parentOrderId
        required: false
        type: string
      - default: 0
        description: Number of results to skip for pagination
        in: query
        name: offset
        required: false
        type: integer
      - default: 25
        description: Maximum number of items to return
        in: query
        maximum: 250
        minimum: 1
        name: limit
        required: false
        type: integer
      - default: -createdAt
        description: Property name that will be used to sort results. '-' indicates descending
        enum:
        - createdAt
        - -createdAt
        - orderId
        - -orderId
        - pricing.total
        - -pricing.total
        in: query
        name: sort
        required: false
        type: string
      - description: Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/OrderList'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_6'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_6'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_6'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_4'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_6'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_6'
      description: <strong>API Resellers</strong><ul><li>This endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header</li></ul>
      operationId: list
      summary: Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time
  /v1/orders/{orderId}:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Order id whose details are to be retrieved
        in: path
        name: orderId
        required: true
        type: string
      - description: Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - default: en-US
        description: Unique identifier of the Market in which the request is happening
        in: header
        name: X-Market-Id
        required: false
        type: string
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Order'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_6'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_6'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_6'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_6'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_4'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_6'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_6'
      description: <strong>API Resellers</strong><ul><li>This endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header</li></ul>
      operationId: get
      summary: Retrieve details for specified order
  /v1/shoppers/subaccount:
    post:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: The subaccount to create
        in: body
        name: subaccount
        required: true
        schema:
          $ref: '#/definitions/SubaccountCreate'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ShopperId'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_7'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_7'
        '422':
          description: '`subaccount` does not fulfill the schema'
          schema:
            $ref: '#/definitions/Error_7'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_5'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_7'
      operationId: createSubaccount
      summary: Create a Subaccount owned by the authenticated Reseller
  /v1/shoppers/{shopperId}:
    get:
      description: <strong>Notes:</strong><ul><li>**shopperId** is **not the same** as **customerId**.  **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: Shopper whose details are to be retrieved
        in: path
        name: shopperId
        required: true
        type: string
      - description: Additional properties to be included in the response shopper object
        in: query
        name: includes
        type: array
        collectionFormat: csv
        items:
          type: string
          enum:
          - customerId
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Shopper'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_7'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_7'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_7'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_5'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_7'
      operationId: get
      summary: Get details for the specified Shopper
    post:
      description: <strong>Notes:</strong><ul><li>**shopperId** is **not the same** as **customerId**.  **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: The ID of the Shopper to update
        in: path
        name: shopperId
        required: true
        type: string
      - description: The Shopper details to update
        in: body
        name: shopper
        required: true
        schema:
          $ref: '#/definitions/ShopperUpdate'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ShopperId'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_7'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_7'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_7'
        '422':
          description: '`Shopper` does not fulfill the schema'
          schema:
            $ref: '#/definitions/Error_7'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_5'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_7'
      operationId: update
      summary: Update details for the specified Shopper
    delete:
      description: <strong>Notes:</strong><ul><li>Shopper deletion is not supported in OTE</li><li>**shopperId** is **not the same** as **customerId**.  **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>
      tags:
      - v1
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: 'The ID of the shopper to delete. Must agree with the shopper id on the token or header, if present. *Note*: **shopperId** is **not the same** as **customerId**.  **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)'
        in: path
        name: shopperId
        maxLength: 10
        required: true
        type: string
      - description: The client IP of the user who originated the request leading to this call.
        in: query
        name: auditClientIp
        required: true
        type: string
      responses:
        '204':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_7'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_7'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_7'
        '409':
          description: Active and locked shoppers cannot be deleted
          schema:
            $ref: '#/definitions/Error_7'
        '422':
          description: Shopper ID is not supplied or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_5'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_7'
      operationId: delete
      summary: Request the deletion of a shopper profile
  /v1/shoppers/{shopperId}/status:
    get:
      description: <strong>Notes:</strong><ul><li>**shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>
      tags:
      - v1
      consumes: []
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: The ID of the shopper to retrieve. Must agree with the shopper id on the token or header, if present
        in: path
        name: shopperId
        maxLength: 10
        required: true
        type: string
      - description: The client IP of the user who originated the request leading to this call.
        in: query
        name: auditClientIp
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ShopperStatus'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_7'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_7'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_7'
        '422':
          description: Shopper ID is not supplied or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_5'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_7'
      operationId: getStatus
      summary: Get details for the specified Shopper
  /v1/shoppers/{shopperId}/factors/password:
    put:
      description: <strong>Notes:</strong><ul><li>Password set is only supported by API Resellers setting subaccount passwords.</li><li>**shopperId** is **not the same** as **customerId**.  **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>
      tags:
      - v1
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - description: Shopper whose password will be set
        in: path
        name: shopperId
        required: true
        type: string
      - description: The value to set the subaccount's password to
        in: body
        name: secret
        required: true
        schema:
          $ref: '#/definitions/Secret'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ShopperId'
        '400':
          description: Request was not successful
          schema:
            $ref: '#/definitions/PasswordError'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_7'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_7'
      operationId: changePassword
      summary: Set subaccount's password
  /v1/subscriptions:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      - description: Shopper ID to return subscriptions for when not using JWT
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - default: en-US
        description: The market that the response should be formatted for
        in: header
        name: X-Market-Id
        required: false
        type: string
      - description: Only return Subscriptions with the specified product groups
        in: query
        items:
          type: string
        name: productGroupKeys
        required: false
        type: array
      - description: Optional details to be included in the response
        enum:
        - addons
        - relations
        - renewOptions
        in: query
        items:
          type: string
        name: includes
        required: false
        type: array
      - default: 0
        description: Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit)
        in: query
        name: offset
        required: false
        type: integer
      - default: 25
        description: Number of Subscriptions to retrieve in this page, starting after offset
        in: query
        maximum: 250
        minimum: 1
        name: limit
        required: false
        type: integer
      - default: -expiresAt
        description: Property name that will be used to sort results. "-" indicates descending
        enum:
        - expiresAt
        - -expiresAt
        in: query
        name: sort
        required: false
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/SubscriptionList'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_8'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_8'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_8'
        '422':
          description: Invalid query parameter (custom message returned for each parameter)
          schema:
            $ref: '#/definitions/Error_8'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_6'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_8'
      operationId: list
      summary: Retrieve a list of Subscriptions for the specified Shopper
  /v1/subscriptions/productGroups:
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      - description: Shopper ID to return data for when not using JWT
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            items:
              $ref: '#/definitions/ProductGroup'
            type: array
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_8'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_8'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_8'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_6'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_8'
      operationId: productGroups
      summary: Retrieve a list of ProductGroups for the specified Shopper
  /v1/subscriptions/{subscriptionId}:
    delete:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      - description: Shopper ID to return data for when not using JWT
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Unique identifier of the Subscription to cancel
        in: path
        name: subscriptionId
        required: true
        type: string
      responses:
        '204':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_8'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_8'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_8'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_8'
        '422':
          description: Failed to determine if the domain is protected (invalid domain ID)<br>Invalid Subscription Id<br>The Office 365 Subscription cannot be cancelled (shopper is migrating)<br>The Subscription cannot be cancelled<br>The Subscription cannot be cancelled (PFID is disabled for cancellation)<br>The Subscription cannot be cancelled (domain is protected)<br>The domain alert Subscription cannot be cancelled
          schema:
            $ref: '#/definitions/Error_8'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_6'
        '500':
          description: Failed to determine if the Office 365 account is migrating<br>Failed to determine if the domain alert is cancellable<br>Failed to determine if the domain is protected<br>Internal server error
          schema:
            $ref: '#/definitions/Error_8'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_8'
      operationId: cancel
      summary: Cancel the specified Subscription
    get:
      tags:
      - v1
      consumes:
      - application/json
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/javascript
      - application/xml
      - text/javascript
      - text/xml
      parameters:
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      - description: Shopper ID to be operated on, if different from JWT
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Unique identifier of the Subscription to retrieve
        in: path
        name: subscriptionId
        required: true
        type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Subscription'
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_8'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_8'
        '403':
          description: Authenticated user is not allowed access
          schema:
            $ref: '#/definitions/Error_8'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/Error_8'
        '422':
          description: Invalid Subscription Id
          schema:
            $ref: '#/definitions/Error_8'
        '429':
          description: Too many requests received within interval
          schema:
            $ref: '#/definitions/ErrorLimit_6'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_8'
        '504':
          description: Gateway timeout
          schema:
            $ref: '#/definitions/Error_8'
      operationId: get
      summary: Retrieve details for the specified Subscription
    patch:
      tags:
      - v1
      consumes:
      - application/json
      - application/x-www-form-urlencoded
      - application/xml
      - text/xml
      produces:
      - application/json
      - application/xml
      parameters:
      - description: A unique application key identifying the source of the request. This is required for request tracking
        in: header
        name: X-App-Key
        required: true
        type: string
      - description: Shopper ID to be operated on, if different from JWT
        in: header
        name: X-Shopper-Id
        required: false
        type: string
      - description: Unique identifier of the Subscription to update
        in: path
        name: subscriptionId
        required: true
        type: string
      - description: Details of the Subscription to change
        in: body
        name: subscription
        required: true
        schema:
          $ref: '#/definitions/SubscriptionUpdate'
      responses:
        '204':
          description: Request was successful
        '400':
          description: Request was malformed
          schema:
            $ref: '#/definitions/Error_8'
        '401':
          description: Authentication info not sent or invalid
          schema:
            $ref: '#/definitions/Error_8'
        '403':
          description: Authenticated user is not allowed access <br> This method only supports JWT authentication
          schema:
            $ref: '#/definitions/Error_8'
        '404':
          description: Subscription not found <br> Payment profile not found
          schema:
            $ref: '#/definitions/Error_8'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/Error_8'
      description: Only Subscription properties that can be changed without immediate financial impact can be modified via PATCH, whereas some properties can be changed by purchasing a renewal<br/><strong>This endpoint only supports JWT authentication</strong>
      operationId: update
      summary: Update details for the specified Subscription
definitions:
  ErrorLimit_3:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_5'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      retryAfterSec:
        description: Number of seconds to wait before attempting a similar request
        format: integer-positive
        type: integer
    required:
    - retryAfterSec
    - code
  OrderSummaryPricing:
    properties:
      total:
        description: Total amount charged for the current order. Negative for Refund and Chargeback
        format: currency-micro-unit
        type: string
    required:
    - total
  DomainAvailableResponse:
    properties:
      available:
        description: Whether or not the domain name is available
        type: boolean
      currency:
        default: USD
        description: Currency in which the `price` is listed. Only returned if tld is offered
        format: iso-currency-code
        type: string
      definitive:
        description: Whether or not the `available` answer has been definitively verified with the registry
        type: boolean
      domain:
        description: Domain name
        type: string
      period:
        description: Number of years included in the price. Only returned if tld is offered
        format: integer-positive
        type: integer
      price:
        description: Price of the domain excluding taxes or fees. Only returned if tld is offered
        format: currency-micro-unit
        type: integer
    required:
    - domain
    - available
    - definitive
  Error_5:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_5'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
    required:
    - code
  JsonSchema:
    properties:
      id:
        type: string
      models:
        items:
          $ref: '#/definitions/JsonSchema'
        type: object
      properties:
        items:
          $ref: '#/definitions/JsonProperty'
        type: object
      required:
        items:
          type: string
        type: array
    required:
    - id
    - properties
    - required
    - models
  Payment:
    properties:
      amount:
        description: Amount paid by the current payment
        format: currency-micro-unit
        type: integer
      category:
        description: 'The category of payment method used at the time of purchase.

          Most common values are listed in the enum.'
        enum:
        - CREDIT_CARD
        - PAYPAL
        - ACH
        - GIFT_CARD
        - IN_STORE_CREDIT
        - PREPAID
        type: string
      paymentProfileId:
        description: Unique identifier of the payment profile used by current payment
        type: string
      subcategory:
        description: "The subcategory of payment method used at the time of purchase.\n This field is only set for certain payment categories, such as ACH and CREDIT_CARD.\nMost common values are listed in the enum."
        enum:
        - CHECKING_PERSONAL
        - CHECKING_BUSINESS
        - VISA
        - MASTER_CARD
        - AMEX
        - JCB
        - UNIONPAY
        type: string
    required:
    - paymentProfileId
    - amount
    - category
  Pagination_2:
    properties:
      first:
        description: URI to access the first page
        type: string
      last:
        description: URI to access the last page
        type: string
      next:
        description: URI to access the next page
        type: string
      previous:
        description: URI to access the previous page
        type: string
      total:
        description: Number of records available
        type: integer
  Pagination:
    properties:
      first:
        description: Optional link to first list of results
        type: string
      last:
        description: Optional link to last list of results
        type: string
      next:
        description: Optional link to next list of results
        type: string
      previous:
        description: Optional link to previous list of results
        type: string
      total:
        description: Number of records available
        type: integer
  CertificateEmailHistory:
    properties:
      id:
        description: Email Id
        type: integer
      accountId:
        description: Shopper Id requested certificate
        type: integer
      templateType:
        description: Email template type name
        type: string
      fromType:
        description: Email from address
        type: string
      recipients:
        description: Email address email was sent
        type: string
      body:
        description: Email message
        type: string
      dateEntered:
        description: Date email sent
        format: iso-datetime
        type: string
      subject:
        description: Email subject
        type: string
    required:
    - id
    - accountId
    - templateType
    - fromType
    - recipients
    - body
    - dateEntered
    - subject
  AbuseTicketCreateLegacy:
    required:
    - type
    allOf:
    - $ref: '#/definitions/AbuseTicketCreateBase'
    - type: object
      properties:
        intentional:
          default: false
          description: Do you believe this is intentional abuse by the domain holder?
          type: boolean
        proxy:
          description: 'The Proxy information required to view the abuse being reported. ie: Specific IP used, or country of IP viewing from'
          type: string
        type:
          description: The type of abuse being reported.
          enum:
          - A_RECORD
          - CHILD_ABUSE
          - CONTENT
          - FRAUD_WIRE
          - IP_BLOCK
          - MALWARE
          - NETWORK_ABUSE
          - PHISHING
          - SPAM
          type: string
  DomainDetail:
    properties:
      authCode:
        description: Authorization code for transferring the Domain
        type: string
      contactAdmin:
        $ref: '#/definitions/Contact'
        description: Administrative contact for the domain registration
      contactBilling:
        $ref: '#/definitions/Contact'
        description: Billing contact for the domain registration
      contactRegistrant:
        $ref: '#/definitions/Contact'
        description: Registration contact for the domain
      contactTech:
        $ref: '#/definitions/Contact'
        description: Technical contact for the domain registration
      createdAt:
        description: Date and time when this domain was created
        format: date-time
        type: string
      deletedAt:
        description: Date and time when this domain was deleted
        format: date-time
        type: string
      transferAwayEligibleAt:
        description: Date and time when this domain is eligible to transfer
        format: date-time
        type: string
      domain:
        description: Name of the domain
        type: string
      domainId:
        description: Unique identifier for this Domain
        format: double
        type: number
      expirationProtected:
        description: Whether or not the domain is protected from expiration
        type: boolean
      expires:
        description: Date and time when this domain will expire
        format: date-time
        type: string
      exposeRegistrantOrganization:
        type: boolean
        description: Whether or not the domain registrant contact organization field should be shown in the WHOIS
      exposeWhois:
        description: Whether or not the domain contact details should be shown in the WHOIS
        type: boolean
      holdRegistrar:
        description: Whether or not the domain is on-hold by the registrar
        type: boolean
      locked:
        description: Whether or not the domain is locked to prevent transfers
        type: boolean
      nameServers:
        description: Fully-qualified domain names for DNS servers
        items:
          format: host-name
          type: string
        type: array
      privacy:
        description: Whether or not the domain has privacy protection
        type: boolean
      registrarCreatedAt:
        type: string
        format: iso-datetime
        description: Date and time when this domain was created by the registrar
      renewAuto:
        description: Whether or not the domain is configured to automatically renew
        type: boolean
      renewDeadline:
        description: Date the domain must renew on
        format: date-time
        type: string
      status:
        description: 'Processing status of the domain<br/><ul>

          <li><strong style=''margin-left: 12px;''>ACTIVE</strong> - All is well</li>

          <li><strong style=''margin-left: 12px;''>AWAITING*</strong> - System is waiting for the end-user to complete an action</li>

          <li><strong style=''margin-left: 12px;''>CANCELLED*</strong> - Domain has been cancelled, and may or may not be reclaimable</li>

          <li><strong style=''margin-left: 12px;''>CONFISCATED</strong> - Domain has been confiscated, usually for abuse, chargeback, or fraud</li>

          <li><strong style=''margin-left: 12px;''>DISABLED*</strong> - Domain has been disabled</li>

          <li><strong style=''margin-left: 12px;''>EXCLUDED*</strong> - Domain has been excluded from Firehose registration</li>

          <li><strong style=''margin-left: 12px;''>EXPIRED*</strong> - Domain has expired</li>

          <li><strong style=''margin-left: 12px;''>FAILED*</strong> - Domain has failed a required action, and the system is no longer retrying</li>

          <li><strong style=''margin-left: 12px;''>HELD*</strong> - Domain has been placed on hold, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>LOCKED*</strong> - Domain has been locked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>PARKED*</strong> - Domain has been parked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>PENDING*</strong> - Domain is working its way through an automated workflow</li>

          <li><strong style=''margin-left: 12px;''>RESERVED*</strong> - Domain is reserved, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>REVERTED</strong> - Domain has been reverted, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>SUSPENDED*</strong> - Domain has been suspended, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>TRANSFERRED*</strong> - Domain has been transferred out</li>

          <li><strong style=''margin-left: 12px;''>UNKNOWN</strong> - Domain is in an unknown state</li>

          <li><strong style=''margin-left: 12px;''>UNLOCKED*</strong> - Domain has been unlocked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>UNPARKED*</strong> - Domain has been unparked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>UPDATED*</strong> - Domain ownership has been transferred to another account</li>

          </ul>'
        type: string
      subaccountId:
        description: Reseller subaccount shopperid who can manage the domain
        type: string
      transferProtected:
        description: Whether or not the domain is protected from transfer
        type: boolean
      verifications:
        $ref: '#/definitions/VerificationsDomain'
        description: Progress and status for each of the verification processes requested for this domain
    required:
    - domainId
    - domain
    - status
    - expirationProtected
    - holdRegistrar
    - locked
    - privacy
    - renewAuto
    - renewDeadline
    - transferProtected
    - createdAt
    - authCode
    - nameServers
    - contactRegistrant
    - contactBilling
    - contactAdmin
    - contactTech
  ShopperId:
    properties:
      customerId:
        description: Identifier for the Customer record associated with this Shopper record. This is an alternate identifier that some systems use to identify an individual shopper record
        type: string
      shopperId:
        type: string
    required:
    - shopperId
  DomainSummary:
    properties:
      authCode:
        description: Authorization code for transferring the Domain
        type: string
      contactAdmin:
        $ref: '#/definitions/Contact'
        description: Administrative contact for the domain registration
      contactBilling:
        $ref: '#/definitions/Contact'
        description: Billing contact for the domain registration
      contactRegistrant:
        $ref: '#/definitions/Contact'
        description: Registration contact for the domain
      contactTech:
        $ref: '#/definitions/Contact'
        description: Technical contact for the domain registration
      createdAt:
        description: Date and time when this domain was created
        format: date-time
        type: string
      deletedAt:
        description: Date and time when this domain was deleted
        format: date-time
        type: string
      transferAwayEligibleAt:
        description: Date and time when this domain is eligible to transfer
        format: date-time
        type: string
      domain:
        description: Name of the domain
        type: string
      domainId:
        description: Unique identifier for this Domain
        format: double
        type: number
      expirationProtected:
        description: Whether or not the domain is protected from expiration
        type: boolean
      expires:
        description: Date and time when this domain will expire
        format: date-time
        type: string
      exposeWhois:
        description: Whether or not the domain contact details should be shown in the WHOIS
        type: boolean
      holdRegistrar:
        description: Whether or not the domain is on-hold by the registrar
        type: boolean
      locked:
        description: Whether or not the domain is locked to prevent transfers
        type: boolean
      nameServers:
        description: Fully-qualified domain names for DNS servers
        items:
          format: host-name
          type: string
        type: array
      privacy:
        description: Whether or not the domain has privacy protection
        type: boolean
      registrarCreatedAt:
        type: string
        format: iso-datetime
        description: Date and time when this domain was created by the registrar
      renewAuto:
        description: Whether or not the domain is configured to automatically renew
        type: boolean
      renewDeadline:
        description: Date the domain must renew on
        format: date-time
        type: string
      renewable:
        description: Whether or not the domain is eligble for renewal based on status
        type: boolean
      status:
        description: 'Processing status of the domain<br/><ul>

          <li><strong style=''margin-left: 12px;''>ACTIVE</strong> - All is well</li>

          <li><strong style=''margin-left: 12px;''>AWAITING*</strong> - System is waiting for the end-user to complete an action</li>

          <li><strong style=''margin-left: 12px;''>CANCELLED*</strong> - Domain has been cancelled, and may or may not be reclaimable</li>

          <li><strong style=''margin-left: 12px;''>CONFISCATED</strong> - Domain has been confiscated, usually for abuse, chargeback, or fraud</li>

          <li><strong style=''margin-left: 12px;''>DISABLED*</strong> - Domain has been disabled</li>

          <li><strong style=''margin-left: 12px;''>EXCLUDED*</strong> - Domain has been excluded from Firehose registration</li>

          <li><strong style=''margin-left: 12px;''>EXPIRED*</strong> - Domain has expired</li>

          <li><strong style=''margin-left: 12px;''>FAILED*</strong> - Domain has failed a required action, and the system is no longer retrying</li>

          <li><strong style=''margin-left: 12px;''>HELD*</strong> - Domain has been placed on hold, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>LOCKED*</strong> - Domain has been locked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>PARKED*</strong> - Domain has been parked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>PENDING*</strong> - Domain is working its way through an automated workflow</li>

          <li><strong style=''margin-left: 12px;''>RESERVED*</strong> - Domain is reserved, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>REVERTED</strong> - Domain has been reverted, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>SUSPENDED*</strong> - Domain has been suspended, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>TRANSFERRED*</strong> - Domain has been transferred out</li>

          <li><strong style=''margin-left: 12px;''>UNKNOWN</strong> - Domain is in an unknown state</li>

          <li><strong style=''margin-left: 12px;''>UNLOCKED*</strong> - Domain has been unlocked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>UNPARKED*</strong> - Domain has been unparked, and likely requires intervention from Support</li>

          <li><strong style=''margin-left: 12px;''>UPDATED*</strong> - Domain ownership has been transferred to another account</li>

          </ul>'
        type: string
      transferProtected:
        description: Whether or not the domain is protected from transfer
        type: boolean
    required:
    - domainId
    - domain
    - status
    - expirationProtected
    - holdRegistrar
    - locked
    - privacy
    - renewAuto
    - renewDeadline
    - transferProtected
    - createdAt
    - contactRegistrant
  SubscriptionAddon:
    properties:
      commitment:
        description: The financial commitment the customer has in the product
        enum:
        - PAID
        - FREE
        - TRIAL
        type: string
      pfid:
        description: Unique identifier of the add-in product
        type: integer
      quantity:
        type: integer
    required:
    - pfid
    - commitment
    - quantity
  Order:
    properties:
      billTo:
        $ref: '#/definitions/BillTo'
        description: The billing contact information that was used at the time of purchase
      createdAt:
        description: Date and time when the current order is created on
        format: iso-datetime
        type: string
      currency:
        description: Currency in which the order has been placed
        format: iso-currency-code
        type: string
      items:
        items:
          $ref: '#/definitions/LineItem'
        type: array
      orderId:
        description: Unique identifier of current order
        type: string
      parentOrderId:
        description: 'Unique identifier of the parent order. All refund/chargeback orders are tied to the original order.

          The orginal order''s `orderId` is the `parentOrderId` of refund/chargeback orders'
        type: string
      payments:
        items:
          $ref: '#/definitions/Payment'
        type: array
      pricing:
        $ref: '#/definitions/OrderPricing'
        description: Pricing information for current order
    required:
    - orderId
    - currency
    - createdAt
    - pricing
    - billTo
    - payments
    - items
  Error_2:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_2'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
    required:
    - code
  CertificateReissue:
    properties:
      callbackUrl:
        description: Required if client would like to receive stateful action via callback during certificate lifecyle
        type: string
      commonName:
        default: Existing common name
        description: The common name of certificate to be secured
        type: string
      csr:
        default: Existing CSR
        description: Certificate Signing Request.
        type: string
      delayExistingRevoke:
        default: 72
        description: In hours, time to delay revoking existing certificate after issuance of new certificate. If revokeExistingCertOnIssuance is enabled, this value will be ignored
        maximum: 168
        type: integer
      rootType:
        default: GODADDY_SHA_1
        description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date
        enum:
        - GODADDY_SHA_1
        - GODADDY_SHA_2
        - STARFIELD_SHA_1
        - STARFIELD_SHA_2
        type: string
      subjectAlternativeNames:
        description: Only used for UCC products. An array of subject alternative names to include in certificate.
        items:
          type: string
        type: array
        uniqueItems: true
      forceDomainRevetting:
        description: Optional field. Domain verification will be required for each domain listed here. Specify a value of * to indicate that all domains associated with the request should have their domain information reverified.
        items:
          type: string
        type: array
        uniqueItems: true
  ErrorFieldDomainContactsValidate:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      domains:
        description: An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains`
        items:
          type: string
        type: array
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: 1) JSONPath referring to the field within the data containing an error<br/>or<br/>2) JSONPath referring to an object containing an error
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to the field on the object referenced by `path` containing an error
        format: json-path
        type: string
    required:
    - code
    - domains
    - path
  ErrorLimit_4:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_6'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      retryAfterSec:
        description: Number of seconds to wait before attempting a similar request
        format: integer-positive
        type: integer
    required:
    - retryAfterSec
    - code
  CertificateRevoke:
    properties:
      reason:
        description: Reason for revocation
        enum:
        - AFFILIATION_CHANGED
        - CESSATION_OF_OPERATION
        - KEY_COMPROMISE
        - PRIVILEGE_WITHDRAWN
        - SUPERSEDED
        type: string
    required:
    - reason
  LineItemPricingTaxDetail:
    properties:
      amount:
        description: Tax amount
        format: currency-micro-unit
        type: integer
      rate:
        format: double
        type: number
    required:
    - ''
  Secret:
    properties:
      secret:
        description: The secret value used to set a subaccount's password
        type: string
        example: P@55w0rd+
  State:
    properties:
      label:
        description: The localized name of the state, province, or territory
        type: string
      stateKey:
        description: The state code
        type: string
  CountrySummary:
    properties:
      callingCode:
        description: The calling code prefix used for phone numbers in this country
        type: string
      countryKey:
        description: The ISO country-code
        format: iso-country-code
        type: string
      label:
        description: The localized name of the country
        type: string
  Address:
    properties:
      address1:
        format: street-address
        type: string
      address2:
        format: street-address2
        type: string
      city:
        format: city-name
        type: string
      country:
        default: US
        description: 'Two-letter ISO country code to be used as a hint for target region<br/><br/>

          NOTE: These are sample values, there are many

          <a href=''http://www.iso.org/iso/country_codes.htm''>more</a>'
        enum:
        - AC
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AO
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AX
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BM
        - BN
        - BO
        - BQ
        - BR
        - BS
        - BT
        - BV
        - BW
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CR
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DE
        - DJ
        - DK
        - DM
        - DO
        - DZ
        - EC
        - EE
        - EG
        - EH
        - ER
        - ES
        - ET
        - FI
        - FJ
        - FK
        - FM
        - FO
        - FR
        - GA
        - GB
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IS
        - IT
        - JE
        - JM
        - JO
        - JP
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KR
        - KV
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MG
        - MH
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NI
        - NL
        - 'NO'
        - NP
        - NR
        - NU
        - NZ
        - OM
        - PA
        - PE
        - PF
        - PG
        - PH
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PW
        - PY
        - QA
        - RE
        - RO
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SE
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - ST
        - SV
        - SX
        - SZ
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TP
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UM
        - US
        - UY
        - UZ
        - VA
        - VC
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WS
        - YE
        - YT
        - ZA
        - ZM
        - ZW
        format: iso-country-code
        type: string
      postalCode:
        description: Postal or zip code
        format: postal-code
        type: string
      state:
        description: State or province or territory
        format: state-province-territory
        type: string
    required:
    - address1
    - city
    - state
    - postalCode
    - country
  AbuseTicketId:
    description: The primary key of a newly created abuse ticket
    properties:
      u_number:
        description: Abuse ticket ID
        type: string
    required:
    - u_number
  Consent:
    properties:
      agreedAt:
        description: Timestamp indicating when the end-user consented to these legal agreements
        format: iso-datetime
        type: string
      agreedBy:
        description: Originating client IP address of the end-user's computer when they consented to these legal agreements
        type: string
      agreementKeys:
        description: Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint
        items:
          type: string
        type: array
    required:
    - agreementKeys
    - agreedBy
    - agreedAt
  ShopperStatus:
    properties:
      billingState:
        type: string
        description: 'Indicates the billing state of the Shopper.<br />ABANDONED: The shopper has not been billed in at least 10 years and has no active subscriptions.<br />INACTIVE: The shopper has been billed within the last 10 years but has no active subscriptions.<br />ACTIVE: The shopper has at least one active subscription.'
        enum:
        - ABANDONED
        - INACTIVE
        - ACTIVE
  ErrorField_7:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: '<ul>

          <li style=''margin-left: 12px;''>JSONPath referring to a field containing an error</li>

          <strong style=''margin-left: 12px;''>OR</strong>

          <li style=''margin-left: 12px;''>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>

          </ul>'
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to a field containing an error, which is referenced by `path`
        format: json-path
        type: string
    required:
    - path
    - code
  Pagination_3:
    properties:
      first:
        description: URI to access the first page
        type: string
      last:
        description: URI to access the last page
        type: string
      next:
        description: URI to access the next page
        type: string
      previous:
        description: URI to access the previous page
        type: string
      total:
        description: Number of records available
        type: integer
  SubaccountCreate:
    properties:
      email:
        format: email
        type: string
      externalId:
        type: integer
      marketId:
        default: en-US
        format: bcp-47
        type: string
        maxLength: 50
        enum:
        - da-DK
        - de-AT
        - de-CH
        - de-DE
        - el-GR
        - en-AE
        - en-AU
        - en-CA
        - en-GB
        - en-HK
        - en-IE
        - en-IL
        - en-IN
        - en-MY
        - en-NZ
        - en-PH
        - en-PK
        - en-SG
        - en-US
        - en-ZA
        - es-AR
        - es-CL
        - es-CO
        - es-ES
        - es-MX
        - es-PE
        - es-US
        - es-VE
        - fi-FI
        - fr-BE
        - fr-CA
        - fr-CH
        - fr-FR
        - hi-IN
        - id-ID
        - it-CH
        - it-IT
        - ja-JP
        - ko-KR
        - mr-IN
        - nb-NO
        - nl-BE
        - nl-NL
        - pl-PL
        - pt-BR
        - pt-PT
        - ru-RU
        - sv-SE
        - ta-IN
        - th-TH
        - tr-TR
        - uk-UA
        - vi-VN
        - zh-HK
        - zh-SG
        - zh-TW
      nameFirst:
        type: string
      nameLast:
        type: string
      password:
        format: shopper-password
        type: string
    required:
    - email
    - password
    - nameFirst
    - nameLast
  ErrorLimit_5:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_7'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      retryAfterSec:
        description: Number of seconds to wait before attempting a similar request
        format: integer-positive
        type: integer
    required:
    - retryAfterSec
    - code
  Error:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      stack:
        description: 'Stack trace indicating where the error occurred.<br/> NOTE: This attribute <strong>MAY</strong> be included for Development and Test environments. However, it <strong>MUST NOT</strong> be exposed from OTE nor Production systems.'
        items:
          type: string
        type: array
    required:
    - code
  ConsentDomainUpdate:
    properties:
      agreedAt:
        description: Timestamp indicating when the end-user consented to these agreements
        format: iso-datetime
        type: string
      agreedBy:
        description: Originating client IP address of the end-user's computer when they consented to the agreements
        type: string
      agreementKeys:
        description: 'Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated<br/><ul><li><strong style=''margin-left: 12px;''>EXPOSE_REGISTRANT_ORGANIZATION</strong> - Required when the exposeRegistrantOrganization field is updated to true</li><li><strong style=''margin-left: 12px;''>EXPOSE_WHOIS</strong> - Required when the exposeWhois field is updated to true</li></ul>'
        items:
          enum:
          - EXPOSE_REGISTRANT_ORGANIZATION
          - EXPOSE_WHOIS
          type: string
        type: array
    required:
    - agreementKeys
    - agreedBy
    - agreedAt
  SubscriptionProduct:
    properties:
      label:
        description: A human readable description of the Product that is subscribed
        type: string
      namespace:
        description: Grouping of related Subscriptions
        type: string
      pfid:
        description: Unique identifier of the Product that is subscribed
        type: integer
      productGroupKey:
        description: Primary key of a grouping of related Subscriptions
        type: string
      renewalPeriod:
        description: The number of `renewalPeriodUnits` that will be added by the `renewalPfid`
        type: integer
      renewalPeriodUnit:
        description: The unit of time that `renewalPeriod` is measured in
        enum:
        - MONTH
        - QUARTER
        - SEMI_ANNUAL
        - YEAR
        type: string
      renewalPfid:
        description: Unique identifier of the renewal Product
        type: integer
      supportBillOn:
        description: Whether the product supports the `billOn` option on the renewal endpoint
        type: boolean
    required:
    - pfid
    - label
    - renewalPfid
    - renewalPeriod
    - renewalPeriodUnit
    - productGroupKey
    - supportBillOn
    - namespace
  VerificationRealName:
    properties:
      status:
        description: 'Status of the real name verification<br/><ul> <li><strong style=''margin-left: 12px;''>APPROVED</strong> - All is well</li> <li><strong style=''margin-left: 12px;''>PENDING</strong> - Real name verification is working its way through the workflow</li> <li><strong style=''margin-left: 12px;''>REJECTED_DOCUMENT_OUTDATED</strong> - Local government verification shows there is a newer version of your document.  Upload the latest version of the document and retry real name verification</li> <li><strong style=''margin-left: 12px;''>REJECTED_EXPIRED_BUSINESS_LICENSE</strong> - Business license is expired</li> <li><strong style=''margin-left: 12px;''>REJECTED_EXPIRED_ORGANIZATION_CODE</strong> - Organization code certificate number has expired</li> <li><strong style=''margin-left: 12px;''>REJECTED_ILLEGIBLE_DOCUMENT_NAME</strong> - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification</li> <li><strong style=''margin-left: 12px;''>REJECTED_ILLEGIBLE_IDENTIFICATION</strong> - Registrant identification is not clear.  Upload a better image to retry</li> <li><strong style=''margin-left: 12px;''>REJECTED_INCOMPLETE_IDENTIFICATION</strong> - Registrant identification is incomplete</li> <li><strong style=''margin-left: 12px;''>REJECTED_INCOMPLETE_REGISTRATION_LETTER</strong> - Registration letter is incomplete</li> <li><strong style=''margin-left: 12px;''>REJECTED_INCONSISTENT_IDENTITY_CARD</strong> - Provided identity card is inconsistent with the identity card on record</li> <li><strong style=''margin-left: 12px;''>REJECTED_INCONSISTENT_ORGANIZATION_CODE</strong> - Provided organization information is inconsistent with the results obtained using the submitted organization code</li> <li><strong style=''margin-left: 12px;''>REJECTED_INCONSISTENT_REGISTRANT_NAME</strong> - Name on the registrant identification does not match the name in the system</li> <li><strong style=''margin-left: 12px;''>REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE</strong> - Your document contains an invalid business license or organization code certificate number</li> <li><strong style=''margin-left: 12px;''>REJECTED_INVALID_DOCUMENT</strong> - Document is invalid.  Please upload another document to retry real name verification</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_BUSINESS_ID</strong> - Business id does not match the business id in the document</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_BUSINESS_NAME</strong> - Business name does not match the business name in the document</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_DOCUMENT_ID</strong> - Document id does not match the id in the document</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_DOCUMENT_NAME</strong> - Document name does not match the name in the document</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_DOCUMENT_TYPE</strong> - Document type does not match the document</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_REGISTRANT_INFO</strong> - The information provided for the registrant does not match the document</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_REGISTRANT_LOCALITY</strong> - Registrant region is overseas, but a local identity document was provided</li> <li><strong style=''margin-left: 12px;''>REJECTED_MISMATCH_REGISTRANT_NAME</strong> - Registrant name has been changed, so the request must be resubmitted</li> <li><strong style=''margin-left: 12px;''>REJECTED_UNABLE_TO_OPEN</strong> - Registrant identification could not be opened.  Please upload the document again to retry real name verification</li> <li><strong style=''margin-left: 12px;''>REJECTED_UNABLE_TO_VERIFY</strong> - Unable to initiate verification.  Please upload the document again to retry real name verification</li> <li><strong style=''margin-left: 12px;''>REJECTED_UNKNOWN_ERROR</strong> - Document was rejected due to an unknown error. For more information, contact customer support</li> <li><strong style=''margin-left: 12px;''>UNABLE_TO_RETRIEVE_STATUS</strong> - Unable to retrieve status for the real name verification process.  Retry, if this status persists, contact customer support</li> </ul>'
        enum:
        - APPROVED
        - PENDING
        - REJECTED_DOCUMENT_OUTDATED
        - REJECTED_EXPIRED_BUSINESS_LICENSE
        - REJECTED_EXPIRED_ORGANIZATION_CODE
        - REJECTED_ILLEGIBLE_DOCUMENT_NAME
        - REJECTED_ILLEGIBLE_IDENTIFICATION
        - REJECTED_INCOMPLETE_IDENTIFICATION
        - REJECTED_INCOMPLETE_REGISTRATION_LETTER
        - REJECTED_INCONSISTENT_IDENTITY_CARD
        - REJECTED_INCONSISTENT_ORGANIZATION_CODE
        - REJECTED_INCONSISTENT_REGISTRANT_NAME
        - REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE
        - REJECTED_INVALID_DOCUMENT
        - REJECTED_MISMATCH_BUSINESS_ID
        - REJECTED_MISMATCH_BUSINESS_NAME
        - REJECTED_MISMATCH_DOCUMENT_ID
        - REJECTED_MISMATCH_DOCUMENT_NAME
        - REJECTED_MISMATCH_DOCUMENT_TYPE
        - REJECTED_MISMATCH_REGISTRANT_INFO
        - REJECTED_MISMATCH_REGISTRANT_LOCALITY
        - REJECTED_MISMATCH_REGISTRANT_NAME
        - REJECTED_UNABLE_TO_OPEN
        - REJECTED_UNABLE_TO_VERIFY
        - REJECTED_UNKNOWN_ERROR
        - UNABLE_TO_RETRIEVE_STATUS
        type: string
    required:
    - status
  ErrorField_2:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: '<ul>

          <li style=''margin-left: 12px;''>JSONPath referring to a field containing an error</li>

          <strong style=''margin-left: 12px;''>OR</strong>

          <li style=''margin-left: 12px;''>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>

          </ul>'
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to a field containing an error, which is referenced by `path`
        format: json-path
        type: string
    required:
    - path
    - code
  ErrorField_4:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: JSONPath referring to the field within the submitted data containing an error
        format: json-path
        type: string
    required:
    - path
    - code
  CertificateIdentifier:
    properties:
      certificateId:
        description: The unique identifier of the certificate request. Only present if verified.
        type: string
    required:
    - certificateId
  DomainAvailableBulk:
    properties:
      domains:
        description: Domain available response array
        items:
          $ref: '#/definitions/DomainAvailableResponse'
        type: array
    required:
    - domains
  BillTo:
    properties:
      contact:
        $ref: '#/definitions/Contact'
        description: Billing contact
      taxId:
        description: Tax id used for calculating the tax the customer is required to pay
        type: string
    required:
    - contact
  CertificateOrganization:
    properties:
      address:
        $ref: '#/definitions/CertificateAddress'
        description: Organization presence address
      assumedName:
        description: Only for EVSSL. The DBA(does business as) name for the organization.
        type: string
      jurisdictionOfIncorporation:
        $ref: '#/definitions/JurisdictionOfIncorporation'
        description: Jurisdiction of Incorporation
      name:
        description: Name of organization that owns common name
        type: string
      phone:
        description: Phone number for organization
        type: string
      registrationAgent:
        description: Only for EVSSL.
        type: string
      registrationNumber:
        description: Only for EVSSL.
        type: string
    required:
    - name
    - phone
    - address
  JsonDataType:
    properties:
      format:
        type: string
      pattern:
        type: string
      type:
        type: string
    required:
    - type
    - $ref
  PrivacyPurchase:
    properties:
      consent:
        $ref: '#/definitions/Consent'
        description: Specify agreement `DNPA`.  Required agreements can be retrieved via the GET ./domains/agreements endpoint
    required:
    - consent
  ErrorField:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: 1) JSONPath referring to the field within the data containing an error<br/>or<br/>2) JSONPath referring to an object containing an error
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to the field on the object referenced by `path` containing an error
        format: json-path
        type: string
    required:
    - path
    - code
  DomainsContactsBulk:
    properties:
      contactAdmin:
        $ref: '#/definitions/Contact'
      contactBilling:
        $ref: '#/definitions/Contact'
      contactPresence:
        $ref: '#/definitions/Contact'
      contactRegistrant:
        $ref: '#/definitions/Contact'
      contactTech:
        $ref: '#/definitions/Contact'
      domains:
        description: An array of domain names to be validated against. Alternatively, you can specify the extracted tlds. However, full domain names are required if the tld is `uk`
        items:
          format: domain
          type: string
        type: array
      entityType:
        description: Canadian Presence Requirement (CA)
        enum:
        - ABORIGINAL
        - ASSOCIATION
        - CITIZEN
        - CORPORATION
        - EDUCATIONAL
        - GOVERNMENT
        - HOSPITAL
        - INDIAN_BAND
        - LEGAL_REPRESENTATIVE
        - LIBRARY_ARCHIVE_MUSEUM
        - MARK_REGISTERED
        - MARK_TRADE
        - PARTNERSHIP
        - POLITICAL_PARTY
        - RESIDENT_PERMANENT
        - TRUST
        - UNION
        type: string
    required:
    - domains
  ErrorDomainContactsValidate:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorFieldDomainContactsValidate'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      stack:
        description: 'Stack trace indicating where the error occurred.<br/>NOTE: This attribute <strong>MAY</strong> be included for Development and Test environments. However, it <strong>MUST NOT</strong> be exposed from OTE nor Production systems'
        items:
          type: string
        type: array
    required:
    - code
  OrderSummary:
    properties:
      createdAt:
        description: Date and time when the current order was created
        format: iso-datetime
        type: string
      currency:
        description: Currency in which the order was placed
        format: iso-currency-code
        type: string
      items:
        description: Sets of two or more line items in current order
        items:
          $ref: '#/definitions/LineItemSummary'
        type: array
      orderId:
        description: Unique identifier of the current order
        type: string
      parentOrderId:
        description: 'Unique identifier of the parent order. All refund/chargeback orders are tied to the original order.

          The orginal order''s `orderId` is the `parentOrderId` of refund/chargeback orders'
        type: string
      pricing:
        $ref: '#/definitions/OrderSummaryPricing'
        description: Pricing information of the current order
    required:
    - orderId
    - currency
    - createdAt
    - pricing
    - items
  Error_3:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_3'
        type: array
      message:
        description: Description of the error
        type: string
    required:
    - code
  OrderPricing:
    properties:
      discount:
        description: Discount from promotional pricing
        format: currency-micro-unit
        type: integer
      fees:
        $ref: '#/definitions/OrderFee'
        description: Fees for the entire cart
      id:
        format: double
        type: number
      list:
        description: Sum of list prices for the entire cart
        format: currency-micro-unit
        type: integer
      savings:
        description: Savings off of list price <pre>`savings` = `list` - `subtotal`</pre>
        format: currency-micro-unit
        type: integer
      subtotal:
        description: Price with `discount` and without taxes or fees
        format: currency-micro-unit
        type: integer
      taxes:
        description: Taxes for the entire cart
        format: currency-micro-unit
        type: integer
      taxDetails:
        description: A collection of line item tax details
        items:
          $ref: '#/definitions/LineItemPricingTaxDetail'
        type: array
      total:
        description: Price the customer pays <pre>`total` = `subtotal` + `taxes` + `fees.total`</pre>
        format: currency-micro-unit
        type: integer
    required:
    - total
    - subtotal
    - list
    - savings
    - discount
    - taxes
    - fees
  ErrorLimit_6:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_8'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      retryAfterSec:
        description: Number of seconds to wait before attempting a similar request
        format: integer-positive
        type: integer
    required:
    - retryAfterSec
    - code
  CertificateOrganizationCreate:
    properties:
      address:
        $ref: '#/definitions/CertificateAddress'
        description: Organization presence address
      assumedName:
        description: Only for EVSSL. The DBA(does business as) name for the organization.
        type: string
      name:
        description: Name of organization that owns common name
        type: string
      phone:
        description: Phone number for organization
        type: string
      registrationAgent:
        description: Only for EVSSL.
        type: string
      registrationNumber:
        description: Only for EVSSL.
        type: string
    required:
    - name
    - phone
  VerificationsDomain:
    properties:
      domainName:
        $ref: '#/definitions/VerificationDomainName'
        description: Verification of domain name against a prohibited list maintained by the government
      realName:
        $ref: '#/definitions/VerificationRealName'
        description: Verification of identity by comparing registration data against government issued documents
  ArrayOfCountrySummary:
    type: array
    items:
      $ref: '#/definitions/CountrySummary'
  ErrorField_5:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: '<ul>

          <li style=''margin-left: 12px;''>JSONPath referring to a field containing an error</li>

          <strong style=''margin-left: 12px;''>OR</strong>

          <li style=''margin-left: 12px;''>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>

          </ul>'
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to a field containing an error, which is referenced by `path`
        format: json-path
        type: string
    required:
    - path
    - code
  LegalAgreement:
    properties:
      agreementKey:
        description: Unique identifier for the legal agreement
        type: string
      content:
        description: Contents of the legal agreement, suitable for embedding
        type: string
      title:
        description: Title of the legal agreement
        type: string
      url:
        description: URL to a page containing the legal agreement
        format: url
        type: string
    required:
    - agreementKey
    - title
    - content
  LineItem:
    properties:
      domains:
        description: A collection of domain names purchased if the current product is domain
        items:
          type: string
        type: array
      label:
        description: Human readable description of the current product
        type: string
      period:
        default: 1
        format: double
        type: number
      periodUnit:
        default: MONTH
        description: The unit of time that periodCount is measured in
        enum:
        - MONTH
        - QUARTER
        - SEMI_ANNUAL
        - YEAR
        - ONE_TIME
        type: string
      pfid:
        description: Unique identifier of the current product
        type: integer
      pricing:
        $ref: '#/definitions/LineItemPricing'
        description: Pricing information of the current line item
      quantity:
        description: Number of the current product included in the specified order
        format: integer-positive
        type: integer
      taxCollector:
        $ref: '#/definitions/LineItemTaxCollector'
        description: Company that collects taxes on the sale of the product
    required:
    - label
    - quantity
    - pricing
  ProductGroup:
    properties:
      productGroupKey:
        description: Primary key of a grouping of related Subscriptions
        type: string
      subscriptionCount:
        description: The number of Subscriptions that the shopper owns in this group
        type: integer
    required:
    - productGroupKey
    - subscriptionCount
  PasswordError:
    properties:
      type:
        description: Response type, always 'error'
        type: string
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
        enum:
        - PW_BLACK_LIST
        - PW_TOO_SHORT
        - PW_TOO_LONG
        - PW_MISSING_UC
        - PW_MISSING_NUM
        - PW_RECENTLY_USED
        - PW_NOT_UNIQUE
      message:
        description: Human-readable, English description of the error
        type: string
  Error_7:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_7'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
    required:
    - code
  CertificateCallback:
    properties:
      callbackUrl:
        description: Callback url registered to receive stateful actions
        type: string
    required:
    - callbackUrl
  CertificateAction:
    properties:
      createdAt:
        description: Date action created
        format: iso-datetime
        type: string
      type:
        enum:
        - CERTIFICATE_ISSUED
        - CERTIFICATE_ORDER_CANCELED
        - CERTIFICATE_ORDER_CREATED
        - CERTIFICATE_REVOKED
        - DOMAIN_VALIDATION_COMPLETE
        - FRAUD_DETECTED
        - ORG_NAME_CHANGE
        - ORG_VALIDATION_COMPLETE
        - SAN_DROP
        type: string
    required:
    - type
    - createdAt
  LineItemSummary:
    properties:
      label:
        description: Product label of the current line item
        type: string
    required:
    - label
  DomainAvailableError:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      domain:
        description: Domain name
        type: string
      message:
        description: Human-readable, English description of the error
        type: string
      path:
        description: '<ul>

          <li style=''margin-left: 12px;''>JSONPath referring to a field containing an error</li>

          <strong style=''margin-left: 12px;''>OR</strong>

          <li style=''margin-left: 12px;''>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>

          </ul>'
        format: json-path
        type: string
      status:
        description: HTTP status code that would return for a single check
        type: integer
    required:
    - code
    - domain
    - path
    - status
  PEMCertificates:
    properties:
      certificate:
        description: End entity certificate in PEM format
        type: string
      cross:
        description: CA Cross Intermediate certificate in PEM format
        type: string
      intermediate:
        description: CA Signing Intermediate certificate in PEM format
        type: string
      root:
        description: CA Root certificate in PEM format
        type: string
    required:
    - certificate
  DomainAvailableBulkMixed:
    properties:
      domains:
        description: Domain available response array
        items:
          $ref: '#/definitions/DomainAvailableResponse'
        type: array
      errors:
        description: Errors encountered while performing a domain available check
        items:
          $ref: '#/definitions/DomainAvailableError'
        type: array
    required:
    - domains
  Shopper:
    properties:
      customerId:
        description: Identifier for the Customer record associated with this Shopper record. This is an alternate identifier that some systems use to identify an individual shopper record
        type: string
      email:
        format: email
        type: string
      externalId:
        type: integer
      marketId:
        default: en-US
        format: bcp-47
        type: string
      nameFirst:
        type: string
      nameLast:
        type: string
      shopperId:
        type: string
    required:
    - shopperId
    - nameFirst
    - nameLast
    - email
    - marketId
  DomainTransferIn:
    properties:
      authCode:
        description: Authorization code from registrar for transferring a domain
        type: string
      consent:
        $ref: '#/definitions/Consent'
        description: Required agreements can be retrieved via the GET ./domains/agreements endpoint
      period:
        default: 1
        description: Can be more than 1 but no more than 10 years total including current registration length
        format: integer-positive
        maximum: 10
        minimum: 1
        type: integer
      privacy:
        default: false
        description: Whether or not privacy has been requested
        type: boolean
      renewAuto:
        default: true
        description: Whether or not the domain should be configured to automatically renew
        type: boolean
      contactAdmin:
        $ref: '#/definitions/Contact'
        description: The contact to use for the domain admin contact. Depending on the tld of the domain being transferred, this field may be required.
      contactBilling:
        $ref: '#/definitions/Contact'
        description: The contact to use for the domain billing contact. Depending on the tld of the domain being transferred, this field may be required.
      contactRegistrant:
        $ref: '#/definitions/Contact'
        description: The contact to use for the domain registrant contact. Depending on the tld of the domain being transferred, this field may be required.
      contactTech:
        $ref: '#/definitions/Contact'
        description: The contact to use for the domain tech contact. Depending on the tld of the domain being transferred, this field may be required.
    required:
    - authCode
    - consent
  DomainContacts:
    properties:
      contactAdmin:
        $ref: '#/definitions/Contact'
      contactBilling:
        $ref: '#/definitions/Contact'
      contactRegistrant:
        $ref: '#/definitions/Contact'
      contactTech:
        $ref: '#/definitions/Contact'
    required:
    - contactRegistrant
  DNSRecord:
    properties:
      data:
        type: string
      name:
        format: domain
        type: string
      port:
        description: Service port (SRV only)
        maximum: 65535
        minimum: 1
        type: integer
      priority:
        description: Record priority (MX and SRV only)
        format: integer-positive
        type: integer
      protocol:
        description: Service protocol (SRV only)
        type: string
      service:
        description: Service type (SRV only)
        type: string
      ttl:
        format: integer-positive
        type: integer
      type:
        enum:
        - A
        - AAAA
        - CNAME
        - MX
        - NS
        - SOA
        - SRV
        - TXT
        type: string
      weight:
        description: Record weight (SRV only)
        format: integer-positive
        type: integer
    required:
    - type
    - name
    - data
  AbuseTicketList:
    properties:
      pagination:
        $ref: '#/definitions/Pagination'
      ticketIds:
        description: A list of abuse ticket ids originated by this reporter.
        items:
          type: string
        type: array
    required:
    - ticketIds
  CertificateCreate:
    properties:
      callbackUrl:
        description: Required if client would like to receive stateful actions via callback during certificate lifecyle
        type: string
      commonName:
        description: Name to be secured in certificate. If provided, CN field in CSR will be ignored.
        type: string
      contact:
        $ref: '#/definitions/CertificateContact'
        description: Requestor contact information
      csr:
        description: Certificate Signing Request
        type: string
      intelVPro:
        default: false
        description: Only used for OV
        type: boolean
      organization:
        $ref: '#/definitions/CertificateOrganizationCreate'
        description: Required for EVSSL, OVSSL, CS, and DS
      period:
        description: Number of years for certificate validity period
        type: integer
      productType:
        description: Type of product requesting a certificate. Only required non-renewal
        enum:
        - DV_SSL
        - DV_WILDCARD_SSL
        - EV_SSL
        - OV_CS
        - OV_DS
        - OV_SSL
        - OV_WILDCARD_SSL
        - UCC_DV_SSL
        - UCC_EV_SSL
        - UCC_OV_SSL
        type: string
      rootType:
        default: STARFIELD_SHA_2
        description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date
        enum:
        - GODADDY_SHA_1
        - GODADDY_SHA_2
        - STARFIELD_SHA_1
        - STARFIELD_SHA_2
        type: string
      slotSize:
        description: 'Number of subject alternative names(SAN) to be included in certificate '
        enum:
        - FIVE
        - TEN
        - FIFTEEN
        - TWENTY
        - THIRTY
        - FOURTY
        - FIFTY
        - ONE_HUNDRED
        type: string
      subjectAlternativeNames:
        description: Subject Alternative names. Collection of subjectAlternativeNames to be included in certificate.
        items:
          type: string
        type: array
        uniqueItems: true
    required:
    - csr
    - productType
    - period
    - contact
  ShopperUpdate:
    properties:
      email:
        format: email
        type: string
      externalId:
        type: integer
      marketId:
        format: bcp-47
        type: string
        maxLength: 50
        enum:
        - da-DK
        - de-AT
        - de-CH
        - de-DE
        - el-GR
        - en-AE
        - en-AU
        - en-CA
        - en-GB
        - en-HK
        - en-IE
        - en-IL
        - en-IN
        - en-MY
        - en-NZ
        - en-PH
        - en-PK
        - en-SG
        - en-US
        - en-ZA
        - es-AR
        - es-CL
        - es-CO
        - es-ES
        - es-MX
        - es-PE
        - es-US
        - es-VE
        - fi-FI
        - fr-BE
        - fr-CA
        - fr-CH
        - fr-FR
        - hi-IN
        - id-ID
        - it-CH
        - it-IT
        - ja-JP
        - ko-KR
        - mr-IN
        - nb-NO
        - nl-BE
        - nl-NL
        - pl-PL
        - pt-BR
        - pt-PT
        - ru-RU
        - sv-SE
        - ta-IN
        - th-TH
        - tr-TR
        - uk-UA
        - vi-VN
        - zh-HK
        - zh-SG
        - zh-TW
      nameFirst:
        type: string
      nameLast:
        type: string
  SubscriptionBilling:
    properties:
      commitment:
        description: The financial commitment the customer has in the product
        enum:
        - PAID
        - FREE
        - TRIAL
        type: string
      pastDueTypes:
        description: The types of charges that are past due when `status` is PAST_DUE
        items:
          enum:
          - ADDON
          - BURST
          - SUBSCRIPTION
          type: string
        type: array
      renewAt:
        description: The point in time after which the Subscription will bill for automatic renewal
        format: iso-datetime
        type: string
      status:
        description: Whether payments are past due
        enum:
        - CURRENT
        - PAST_DUE
        type: string
    required:
    - renewAt
    - status
    - commitment
  AbuseTicketCreateBase:
    required:
    - source
    properties:
      info:
        description: 'Additional information that may assist the abuse investigator. ie: server logs or email headers/body for SPAM'
        type: string
      infoUrl:
        description: Reporter URL if housing additional information that may assist the abuse investigator
        format: url
        type: string
      source:
        description: 'The URL or IP where live abuse content is located at. ie: https://www.example.com/bad_stuff/bad.php'
        type: string
      target:
        description: 'The brand/company the abuse is targeting. ie: brand name/bank name'
        type: string
  SubscriptionUpdate:
    properties:
      paymentProfileId:
        description: Unique identifier of the payment profile you want to be used for automatic renewal
        type: integer
      renewAuto:
        description: Whether or not you want the Subscription renew automatically
        type: boolean
  CertificateSiteSeal:
    properties:
      html:
        description: Certificate Seal HTML
        type: string
    required:
    - html
  ErrorLimit_2:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_4'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      retryAfterSec:
        description: Number of seconds to wait before attempting a similar request
        format: integer-positive
        type: integer
      stack:
        description: 'Stack trace indicating where the error occurred.<br/>

          NOTE: This attribute <strong>MAY</strong> be included for Development and Test environments.

          However, it <strong>MUST NOT</strong> be exposed from OTE nor Production systems'
        items:
          type: string
        type: array
    required:
    - retryAfterSec
    - code
  Country:
    properties:
      callingCode:
        description: The calling code prefix used for phone numbers in this country
        type: string
      countryKey:
        description: The ISO country-code
        format: iso-country-code
        type: string
      label:
        description: The localized name of the country
        type: string
      states:
        description: List of states/provinces in this country
        items:
          $ref: '#/definitions/State'
        type: array
  ErrorField_8:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: '<ul>

          <li style=''margin-left: 12px;''>JSONPath referring to a field containing an error</li>

          <strong style=''margin-left: 12px;''>OR</strong>

          <li style=''margin-left: 12px;''>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>

          </ul>'
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to a field containing an error, which is referenced by `path`
        format: json-path
        type: string
    required:
    - path
    - code
  LineItemPricing:
    properties:
      discount:
        description: Discount off of sale price for given `quantity` and `period` <pre>`discount` = `sale` - `subtotal`</pre>
        format: currency-micro-unit
        type: integer
      fees:
        $ref: '#/definitions/OrderFee'
        description: Fees for given `quantity` and `period`
      list:
        description: List price for given `quantity` and `period`
        format: currency-micro-unit
        type: integer
      sale:
        description: Actual price for the current product
        format: currency-micro-unit
        type: integer
      savings:
        description: Savings off of list price for given `quantity` and `period` <pre>`savings` = `list` - `subtotal`</pre>
        format: currency-micro-unit
        type: integer
      subtotal:
        description: Price with any discounts and without taxes or fees for given `quantity` and `period`
        format: currency-micro-unit
        type: integer
      taxes:
        description: Taxes for given `quantity` and `period`
        format: currency-micro-unit
        type: integer
      unit:
        description: Pricing for a single unit of the given item
        type: object
    required:
    - subtotal
    - list
    - savings
    - sale
    - discount
    - taxes
    - fees
    - unit
  CertificateContact:
    properties:
      email:
        description: Email address of requestor contact
        type: string
      jobTitle:
        description: Only used for EVSSL. Job title of requestor contact
        type: string
      nameFirst:
        description: First name of requestor contact
        type: string
      nameLast:
        description: Last name of requestor contact
        type: string
      nameMiddle:
        description: Middle initial of requestor contact
        type: string
      phone:
        description: Phone number for requestor contact
        type: string
      suffix:
        description: Suffix of requestor contact
        type: string
    required:
    - nameFirst
    - nameLast
    - email
    - phone
  DNSRecordCreateType:
    properties:
      data:
        type: string
      name:
        format: domain
        type: string
      port:
        description: Service port (SRV only)
        maximum: 65535
        minimum: 1
        type: integer
      priority:
        description: Record priority (MX and SRV only)
        format: integer-positive
        type: integer
      protocol:
        description: Service protocol (SRV only)
        type: string
      service:
        description: Service type (SRV only)
        type: string
      ttl:
        format: integer-positive
        type: integer
      weight:
        description: Record weight (SRV only)
        format: integer-positive
        type: integer
    required:
    - name
    - data
  OrderFee:
    properties:
      icann:
        description: Domain registration transaction fee charged by ICANN
        format: currency-micro-unit
        type: integer
      total:
        description: Sum of all fees
        format: currency-micro-unit
        type: integer
    required:
    - total
  SubjectAlternativeNameDetails:
    properties:
      status:
        description: Total number of page results
        enum:
        - PENDING
        - INVALID
        - COMPLETED
        - FRAUD
        type: string
      subjectAlternativeName:
        description: Subject alternative name to be included in certificate
        type: string
    required:
    - subjectAlternativeName
    - status
  Error_6:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_6'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
    required:
    - code
  Error_8:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_8'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
    required:
    - code
  CertificateRenew:
    properties:
      callbackUrl:
        description: Required if client would like to receive stateful actions via callback during certificate lifecyle
        type: string
      commonName:
        default: Existing common name
        description: The common name of certificate to be secured
        type: string
      csr:
        default: Existing CSR
        description: Certificate Signing Request.
        type: string
      period:
        default: 0
        description: Number of years for certificate validity period, if different from previous certificate
        type: integer
      rootType:
        default: GODADDY_SHA_1
        description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date
        enum:
        - GODADDY_SHA_1
        - GODADDY_SHA_2
        - STARFIELD_SHA_1
        - STARFIELD_SHA_2
        type: string
      subjectAlternativeNames:
        description: Only used for UCC products. An array of subject alternative names to include in certificate. Not including a subject alternative name that was in the previous certificate will remove it from the renewed certificate.
        items:
          type: string
        type: array
        uniqueItems: true
  CertificateAddress:
    properties:
      address1:
        description: Address line 1 of organization address
        type: string
      address2:
        description: Address line 2 of organization address
        type: string
      city:
        description: City/Locality of organization address
        type: string
      country:
        description: Two character country code of organization
        enum:
        - AC
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AN
        - AO
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BM
        - BN
        - BO
        - BR
        - BS
        - BT
        - BV
        - BW
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CR
        - CV
        - CX
        - CY
        - CZ
        - DE
        - DJ
        - DK
        - DM
        - DO
        - DZ
        - EC
        - EE
        - EG
        - EH
        - ER
        - ES
        - ET
        - FI
        - FJ
        - FK
        - FM
        - FO
        - FR
        - GA
        - GB
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IS
        - IT
        - JE
        - JM
        - JO
        - JP
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KR
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MG
        - MH
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NI
        - NL
        - 'NO'
        - NP
        - NR
        - NU
        - NZ
        - OM
        - PA
        - PE
        - PF
        - PG
        - PH
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PW
        - PY
        - QA
        - RE
        - RO
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SE
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - ST
        - SV
        - SZ
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TP
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UM
        - US
        - UY
        - UZ
        - VA
        - VC
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WS
        - YE
        - YT
        - YU
        - ZA
        - ZM
        - ZW
        format: iso-country-code
        type: string
      postalCode:
        description: Postal code of organization address
        type: string
      state:
        description: Full name of State/Province/Territory of organization address
        type: string
    required:
    - address1
    - country
  DomainPurchase:
    properties:
      consent:
        $ref: '#/definitions/Consent'
      contactAdmin:
        $ref: '#/definitions/Contact'
      contactBilling:
        $ref: '#/definitions/Contact'
      contactRegistrant:
        $ref: '#/definitions/Contact'
      contactTech:
        $ref: '#/definitions/Contact'
      domain:
        description: For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked
        format: domain
        type: string
      nameServers:
        items:
          format: host-name
          type: string
        type: array
      period:
        default: 1
        format: integer-positive
        maximum: 10
        minimum: 1
        type: integer
      privacy:
        default: false
        type: boolean
      renewAuto:
        default: true
        type: boolean
    required:
    - domain
    - consent
  ArrayOfCountry:
    type: array
    items:
      $ref: '#/definitions/Country'
  VerificationDomainName:
    properties:
      status:
        description: Status of the domain name verification
        enum:
        - APPROVED
        - PENDING
        - REJECTED
        - UNABLE_TO_RETRIEVE_STATUS
        type: string
    required:
    - status
  Certificate:
    properties:
      certificateId:
        description: The unique identifier of the certificate request. Only present if no errors returned
        type: string
      commonName:
        description: Common name of certificate
        type: string
      contact:
        $ref: '#/definitions/CertificateContact'
        description: Requestor contact information
      createdAt:
        description: The date the certificate was ordered.
        format: iso-datetime
        type: string
      deniedReason:
        description: Only present if certificate order has been denied
        type: string
      organization:
        $ref: '#/definitions/CertificateOrganization'
        description: Organization Name in certificate
      period:
        description: Validity period of order. Specified in years
        type: integer
      productType:
        description: Certificate product type
        enum:
        - DV_SSL
        - DV_WILDCARD_SSL
        - EV_SSL
        - OV_CS
        - OV_DS
        - OV_SSL
        - OV_WILDCARD_SSL
        - UCC_DV_SSL
        - UCC_EV_SSL
        - UCC_OV_SSL
        type: string
      progress:
        description: Percentage of completion for certificate vetting
        type: integer
      revokedAt:
        description: The revocation date of certificate (if revoked).
        format: iso-datetime
        type: string
      rootType:
        description: Root Type
        enum:
        - GODADDY_SHA_1
        - GODADDY_SHA_2
        - STARFIELD_SHA_1
        - STARFIELD_SHA_2
        type: string
      serialNumber:
        description: Serial number of certificate (if issued or revoked)
        type: string
      serialNumberHex:
        description: Hexadecmial format for Serial number of certificate(if issued or revoked)
        type: string
      slotSize:
        description: 'Number of subject alternative names(SAN) to be included in certificate '
        enum:
        - FIVE
        - TEN
        - FIFTEEN
        - TWENTY
        - THIRTY
        - FOURTY
        - FIFTY
        - ONE_HUNDRED
        type: string
      status:
        description: Status of certificate
        enum:
        - PENDING_ISSUANCE
        - ISSUED
        - REVOKED
        - CANCELED
        - DENIED
        - PENDING_REVOCATION
        - PENDING_REKEY
        - UNUSED
        - EXPIRED
        type: string
      subjectAlternativeNames:
        description: Contains subject alternative names set
        items:
          $ref: '#/definitions/SubjectAlternativeNameDetails'
        type: array
      validEnd:
        description: The end date of the certificate's validity (if issued or revoked).
        format: iso-datetime
        type: string
      validStart:
        description: The start date of the certificate's validity (if issued or revoked).
        format: iso-datetime
        type: string
    required:
    - certificateId
    - status
    - contact
    - period
    - createdAt
    - productType
  SubscriptionRelations:
    properties:
      children:
        description: A set of related Subscriptions that will be canceled automatically if this Subscription is canceled
        items:
          type: string
        type: array
      parent:
        description: Unique identifier of this Subscription's parent
        type: string
  Error_4:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_4'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      stack:
        description: 'Stack trace indicating where the error occurred.<br/>

          NOTE: This attribute <strong>MAY</strong> be included for Development and Test environments.

          However, it <strong>MUST NOT</strong> be exposed from OTE nor Production systems'
        items:
          type: string
        type: array
    required:
    - code
  LineItemTaxCollector:
    properties:
      taxCollectorId:
        description: Unique identifier for the company
        format: integer-positive
        type: integer
    required:
    - taxCollectorId
  DomainSuggestion:
    properties:
      domain:
        description: Suggested domain name
        type: string
    required:
    - domain
  TldSummary:
    properties:
      name:
        description: Name of the top-level domain
        format: tld
        type: string
      type:
        default: GENERIC
        description: Type of the top-level domain
        enum:
        - COUNTRY_CODE
        - GENERIC
        type: string
    required:
    - name
    - type
  SubscriptionList:
    properties:
      pagination:
        $ref: '#/definitions/Pagination_3'
        description: Pagination information
      subscriptions:
        description: A collection of subscriptions
        items:
          $ref: '#/definitions/Subscription'
        type: array
    required:
    - subscriptions
    - pagination
  CertificateBundle:
    properties:
      pems:
        $ref: '#/definitions/PEMCertificates'
        description: Certificates in PEM format
      serialNumber:
        description: Serial number of certificate requested
        type: string
    required:
    - serialNumber
    - pems
  ErrorLimit:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      fields:
        description: List of the specific fields, and the errors found with their contents
        items:
          $ref: '#/definitions/ErrorField_2'
        type: array
      message:
        description: Human-readable, English description of the error
        type: string
      retryAfterSec:
        description: Number of seconds to wait before attempting a similar request
        format: integer-positive
        type: integer
    required:
    - retryAfterSec
    - code
  Subscription:
    properties:
      addons:
        description: An array of additional products that have been purchased to augment this Subscription
        items:
          $ref: '#/definitions/SubscriptionAddon'
        type: array
      billing:
        $ref: '#/definitions/SubscriptionBilling'
      cancelable:
        description: Whether or not the Subscription is allowed to be canceled
        type: boolean
      createdAt:
        description: When the Subscription was created
        format: iso-datetime
        type: string
      expiresAt:
        description: When the Subscription will expire
        format: iso-datetime
        type: string
      label:
        description: A human readable description of this Subscription
        type: string
      launchUrl:
        description: The url to use or manage this Subscription's active product
        format: url
        type: string
      paymentProfileId:
        description: Unique identifier of the payment profile that will be used to automatically renew this Subscription
        type: integer
      priceLocked:
        description: Whether the renewal price will be based from the list price or a locked-in price for this shopper
        type: boolean
      product:
        $ref: '#/definitions/SubscriptionProduct'
      relations:
        $ref: '#/definitions/SubscriptionRelations'
      renewAuto:
        description: Whether or not the Subscription is set to be automatically renewed via the billing agent
        type: boolean
      renewable:
        description: Whether or not the Subscription is allowed to be renewed
        type: boolean
      status:
        description: Whether the Subscription is active or the specific non-active state
        enum:
        - ACTIVE
        - PENDING
        - CANCELED
        type: string
      subscriptionId:
        description: Unique identifier of the Subscription
        type: string
      upgradeable:
        description: Whether or not the Subscription is allowed to be upgraded
        type: boolean
    required:
    - subscriptionId
    - status
    - product
    - createdAt
    - billing
    - renewable
    - upgradeable
    - priceLocked
    - renewAuto
  JurisdictionOfIncorporation:
    properties:
      city:
        type: string
      country:
        format: iso-country-code
        type: string
      county:
        type: string
      state:
        type: string
    required:
    - country
  DomainRenew:
    properties:
      period:
        description: Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase
        format: integer-positive
        maximum: 10
        minimum: 1
        type: integer
  AbuseTicketLegacy:
    description: The associated fields returned, given a unique abuse ticket id
    properties:
      closed:
        default: false
        description: Is this abuse ticket closed?
        type: boolean
      closedAt:
        description: The date the abuse ticket was closed
        format: iso-datetime
        type: string
      createdAt:
        description: The date the abuse ticket was created
        format: iso-datetime
        type: string
      domainIp:
        description: The domain or IP the suspected abuse was reported against
        type: string
      reporter:
        description: The shopper id of the person who reported the suspected abuse
        type: string
      source:
        description: The single URL or IP the suspected abuse was reported against
        type: string
      target:
        description: The company the suspected abuse is targeting
        type: string
      ticketId:
        description: Abuse ticket ID
        type: string
      type:
        description: The type of abuse being reported
        enum:
        - A_RECORD
        - CHILD_ABUSE
        - CONTENT
        - FRAUD_WIRE
        - IP_BLOCK
        - MALWARE
        - NETWORK_ABUSE
        - PHISHING
        - SPAM
        type: string
    required:
    - ticketId
    - reporter
    - domainIp
    - closed
    - type
    - target
    - source
    - createdAt
    - closedAt
  DomainUpdate:
    properties:
      locked:
        description: Whether or not the domain should be locked to prevent transfers
        type: boolean
      nameServers:
        description: Fully-qualified domain names for Name Servers to associate with the domain
        items:
          format: host-name
        type: array
      renewAuto:
        description: Whether or not the domain should be configured to automatically renew
        type: boolean
      subaccountId:
        description: Reseller subaccount shopperid who can manage the domain
        type: string
      exposeRegistrantOrganization:
        type: boolean
        description: Whether or not the domain registrant contact organization field should be shown in the WHOIS
      exposeWhois:
        description: Whether or not the domain contact details should be shown in the WHOIS
        type: boolean
      consent:
        $ref: '#/definitions/ConsentDomainUpdate'
  Contact:
    properties:
      addressMailing:
        $ref: '#/definitions/Address'
      email:
        format: email
        type: string
      fax:
        format: phone
        type: string
      jobTitle:
        type: string
      nameFirst:
        format: person-name
        type: string
      nameLast:
        format: person-name
        type: string
      nameMiddle:
        type: string
      organization:
        format: organization-name
        type: string
      phone:
        format: phone
        type: string
    required:
    - nameFirst
    - nameLast
    - email
    - phone
    - addressMailing
  ErrorField_3:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Description of the problem with the contents of the field
        type: string
      path:
        description: JSONPath referring to the field within the submitted data containing an error
        format: json-path
        type: string
    required:
    - path
    - code
  JsonProperty:
    properties:
      defaultValue:
        type: string
      format:
        type: string
      items:
        items:
          $ref: '#/definitions/JsonDataType'
        type: object
      maxItems:
        type: integer
      maximum:
        type: integer
      minItems:
        type: integer
      minimum:
        type: integer
      pattern:
        type: string
      required:
        type: boolean
      type:
        type: string
    required:
    - type
    - $ref
    - required
  DomainPurchaseResponse:
    properties:
      currency:
        default: USD
        description: Currency in which the `total` is listed
        format: iso-currency-code
        type: string
      itemCount:
        description: Number items included in the order
        format: integer-positive
        type: integer
      orderId:
        description: Unique identifier of the order processed to purchase the domain
        format: int64
        type: integer
      total:
        description: Total cost of the domain and any selected add-ons
        format: currency-micro-unit
        type: integer
    required:
    - orderId
    - itemCount
    - total
  ErrorField_6:
    properties:
      code:
        description: Short identifier for the error, suitable for indicating the specific error within client code
        format: constant
        type: string
      message:
        description: Human-readable, English description of the problem with the contents of the field
        type: string
      path:
        description: '<ul>

          <li style=''margin-left: 12px;''>JSONPath referring to a field containing an error</li>

          <strong style=''margin-left: 12px;''>OR</strong>

          <li style=''margin-left: 12px;''>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>

          </ul>'
        format: json-path
        type: string
      pathRelated:
        description: JSONPath referring to a field containing an error, which is referenced by `path`
        format: json-path
        type: string
    required:
    - path
    - code
  DNSRecordCreateTypeName:
    properties:
      data:
        type: string
      port:
        description: Service port (SRV only)
        maximum: 65535
        minimum: 1
        type: integer
      priority:
        description: Record priority (MX and SRV only)
        format: integer-positive
        type: integer
      protocol:
        description: Service protocol (SRV only)
        type: string
      service:
        description: Service type (SRV only)
        type: string
      ttl:
        format: integer-positive
        type: integer
      weight:
        description: Record weight (SRV only)
        format: integer-positive
        type: integer
    required:
    - data
  ArrayOfCertificateAction:
    type: array
    items:
      $ref: '#/definitions/CertificateAction'
  ArrayOfDNSRecord:
    type: array
    items:
      $ref: '#/definitions/DNSRecord'
  OrderList:
    properties:
      orders:
        description: A collection of orders
        items:
          $ref: '#/definitions/OrderSummary'
        type: array
      pagination:
        $ref: '#/definitions/Pagination_2'
        description: Pagination information
    required:
    - orders
    - pagination