registration_quotes_v3

GoDaddy Domains v3 API (Personal Access Token only). Mutations are asynchronous and return an operation to poll via domains.operations_v3.

Overview

Name	registration_quotes_v3
Type	Resource
Id	godaddy.registration.registration_quotes_v3

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	domain	x_request_id, isc_code	Prices the registration, resolves contact and preference settings, returns required legal agreements, and mints a single-use quoteToken with a 10-minute TTL. Free and read-only; safe to call speculatively. When the domain is unavailable, available: false is returned with no quoteToken — this is a valid non-error response. When required contact fields are missing, a 422 is returned with field-level details so the agent can collect the missing data and re-quote. May pass iscCode to lock pricing at applicable rates; the same value must be supplied on /registrations if provided here. The period supplied here must be re-supplied on /registrations; a mismatch returns quote_mismatch. If profile or profileId is supplied here, the same value must be re-supplied on /registrations; a mismatch returns quote_mismatch. PREMIUM domains: when the quoted domain has inventory PREMIUM, the response includes a fees array containing a ONE_TIME_PREMIUM_DOMAIN_PURCHASE entry. The execute request must echo this array verbatim in consent.acknowledgedFees to confirm the customer accepted the specific charge before the irreversible purchase proceeds.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
isc_code	string	ISC (International Shopper Code) for pricing context. When provided, prices reflect the applicable rates for this ISC. (example: ISC_PARTNER_001) (wire: iscCode)
x_request_id	string (uuid)	Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. (wire: X-Request-Id)

INSERT examples

create

Prices the registration, resolves contact and preference settings,
returns required legal agreements, and mints a single-use quoteToken
with a 10-minute TTL. Free and read-only; safe to call speculatively.

When the domain is unavailable, available: false is returned with
no quoteToken — this is a valid non-error response.

When required contact fields are missing, a 422 is returned with
field-level details so the agent can collect the missing data and re-quote.

May pass iscCode to lock pricing at applicable rates;
the same value must be supplied on /registrations if provided here.
The period supplied here must be re-supplied on /registrations;
a mismatch returns quote_mismatch.
If profile or profileId is supplied here, the same value must be
re-supplied on /registrations; a mismatch returns quote_mismatch.

PREMIUM domains: when the quoted domain has inventory PREMIUM,
the response includes a fees array containing a
ONE_TIME_PREMIUM_DOMAIN_PURCHASE entry. The execute request must
echo this array verbatim in consent.acknowledgedFees to confirm
the customer accepted the specific charge before the irreversible
purchase proceeds.

INSERT INTO godaddy.registration.registration_quotes_v3 (
domain,
period,
profile_id,
profile,
x_request_id,
isc_code
)
SELECT 
'{{ domain }}' /* required */,
{{ period }},
'{{ profile_id }}',
'{{ profile }}',
'{{ x_request_id }}',
'{{ isc_code }}'
RETURNING
available,
domain,
expires_at,
fees,
inventory,
irreversible,
period,
price,
quote_token,
renewal_price,
required_agreements,
resolved
;

Manifest

# Description fields are for documentation purposes
- name: registration_quotes_v3
props:
  - name: domain
    value: "{{ domain }}"
    description: |
      The domain name to quote, in punycode A-label form.
  - name: period
    value: {{ period }}
    description: |
      Registration period in years. If supplied, the same value must be re-supplied on /registrations.
    default: 1
  - name: profile_id
    value: "{{ profile_id }}"
    description: |
      A universally unique identifier (UUID) in [RFC-4122 format](https://tools.ietf.org/html/rfc4122).
  - name: profile
    description: |
      A one-time, non-persisted set of contacts and purchase preference defaults supplied inline on a quote or execute request. Use to provide registration data for this transaction without creating or updating a saved registration profile.
      Shared by the registration quote and execute request bodies. Every field is optional. Omitted fields account identity or other default values. Provided fields override only what is supplied — contact roles replace as a whole block; preference fields replace individually.
      This is not a saved registration profile and is not JSON Patch. Data here applies only to the current quote or registration request.
    value:
      contacts:
        registrant:
          firstName: "{{ firstName }}"
          lastName: "{{ lastName }}"
          organization: "{{ organization }}"
          email: "{{ email }}"
          phone:
            countryCode: "{{ countryCode }}"
            nationalNumber: "{{ nationalNumber }}"
            extensionNumber: "{{ extensionNumber }}"
          address:
            line1: "{{ line1 }}"
            line2: "{{ line2 }}"
            city: "{{ city }}"
            state: "{{ state }}"
            countryCode: "{{ countryCode }}"
            postalCode: "{{ postalCode }}"
        admin:
          firstName: "{{ firstName }}"
          lastName: "{{ lastName }}"
          organization: "{{ organization }}"
          email: "{{ email }}"
          phone:
            countryCode: "{{ countryCode }}"
            nationalNumber: "{{ nationalNumber }}"
            extensionNumber: "{{ extensionNumber }}"
          address:
            line1: "{{ line1 }}"
            line2: "{{ line2 }}"
            city: "{{ city }}"
            state: "{{ state }}"
            countryCode: "{{ countryCode }}"
            postalCode: "{{ postalCode }}"
        tech:
          firstName: "{{ firstName }}"
          lastName: "{{ lastName }}"
          organization: "{{ organization }}"
          email: "{{ email }}"
          phone:
            countryCode: "{{ countryCode }}"
            nationalNumber: "{{ nationalNumber }}"
            extensionNumber: "{{ extensionNumber }}"
          address:
            line1: "{{ line1 }}"
            line2: "{{ line2 }}"
            city: "{{ city }}"
            state: "{{ state }}"
            countryCode: "{{ countryCode }}"
            postalCode: "{{ postalCode }}"
        billing:
          firstName: "{{ firstName }}"
          lastName: "{{ lastName }}"
          organization: "{{ organization }}"
          email: "{{ email }}"
          phone:
            countryCode: "{{ countryCode }}"
            nationalNumber: "{{ nationalNumber }}"
            extensionNumber: "{{ extensionNumber }}"
          address:
            line1: "{{ line1 }}"
            line2: "{{ line2 }}"
            city: "{{ city }}"
            state: "{{ state }}"
            countryCode: "{{ countryCode }}"
            postalCode: "{{ postalCode }}"
      autoRenew: {{ autoRenew }}
      privacy: {{ privacy }}
      nameServers:
        - "{{ nameServers }}"
  - name: x_request_id
    value: "{{ x_request_id }}"
    description: Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. 
    description: Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. 
  - name: isc_code
    value: "{{ isc_code }}"
    description: ISC (International Shopper Code) for pricing context. When provided, prices reflect the applicable rates for this ISC.  (example: ISC_PARTNER_001)
    description: ISC (International Shopper Code) for pricing context. When provided, prices reflect the applicable rates for this ISC.  (example: ISC_PARTNER_001)