--- title: renew-a-domain product: vercel url: /docs/rest-api/domains-registrar/renew-a-domain type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about renew-a-domain on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # Renew a domain ```http POST /v1/registrar/domains/{domain}/renew ``` Renew a domain ## Authentication **bearerToken**: HTTP bearer ## Path parameters | Name | Type | Required | Description | |---|---|---|---| | `domain` | string | Yes | | ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `teamId` | string | No | | ## Request body Required: Yes Content-Type: `application/json` ```json { "type": "object", "required": [ "years", "expectedPrice" ], "properties": { "years": { "type": "number", "description": "The number of years to renew the domain for." }, "expectedPrice": { "type": "number", "minimum": 0.01 }, "contactInformation": { "type": "object", "required": [ "firstName", "lastName", "email", "phone", "address1", "city", "state", "zip", "country" ], "properties": { "firstName": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "lastName": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "email": { "type": "string", "description": "A valid RFC 5322 email address", "minLength": 1 }, "phone": { "type": "string", "description": "A valid E.164 phone number", "pattern": "^(?=(?:\\D*\\d){8,15}$)\\+[1-9]\\d{0,2}\\.?\\d+$", "minLength": 1 }, "address1": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "address2": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "city": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "state": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "zip": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "country": { "type": "string", "description": "A valid ISO 3166-1 alpha-2 country code" }, "companyName": { "type": "string", "description": "a non empty string", "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$", "minLength": 1 }, "fax": { "type": "string", "description": "A valid E.164 phone number", "pattern": "^(?=(?:\\D*\\d){8,15}$)\\+[1-9]\\d{0,2}\\.?\\d+$", "minLength": 1 } } } } } ``` ## Responses ### 200: Success Content-Type: `application/json` ```json { "type": "object", "required": [ "orderId", "_links" ], "properties": { "orderId": { "type": "string", "description": "A valid order ID" }, "_links": { "type": "object", "additionalProperties": { "type": "object", "required": [ "href", "method" ], "properties": { "href": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH" ] } } } } } } ``` ### 400: There was something wrong with the request Content-Type: `application/json` ```json { "anyOf": [ { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "bad_request" ] }, "message": { "type": "string" } } }, { "type": "object", "description": "The domain name (excluding the TLD) is too short.", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "domain_too_short" ] }, "message": { "type": "string" } } }, { "type": "object", "description": "The domain is not registered with Vercel.", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "domain_not_registered" ] }, "message": { "type": "string" } } }, { "type": "object", "description": "The expected price passed does not match the actual price.", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "expected_price_mismatch" ] }, "message": { "type": "string" } } }, { "type": "object", "description": "The domain is not available.", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "domain_not_available" ] }, "message": { "type": "string" } } }, { "type": "object", "description": "The TLD is not currently supported.", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "tld_not_supported" ] }, "message": { "type": "string" } } }, { "type": "object", "description": "The request did not match the expected schema", "required": [ "issues", "message" ], "properties": { "issues": { "type": "array", "items": { "type": "object", "description": "Represents an error encountered while parsing a value to match the schema", "required": [ "path", "message" ], "properties": { "path": { "type": "array", "description": "The path to the property where the issue occurred", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "description": "an object to be decoded into a globally shared symbol", "required": [ "_tag", "key" ], "properties": { "_tag": { "type": "string", "enum": [ "symbol" ] }, "key": { "type": "string" } } } ] } }, "message": { "type": "string", "description": "A descriptive message explaining the issue" } } } }, "message": { "type": "string" } } } ] } ``` ### 401: Unauthorized Content-Type: `application/json` ```json { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 401 ] }, "code": { "type": "string", "enum": [ "unauthorized" ] }, "message": { "type": "string" } } } ``` ### 403: NotAuthorizedForScope Content-Type: `application/json` ```json { "anyOf": [ { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 403 ] }, "code": { "type": "string", "enum": [ "not_authorized_for_scope" ] }, "message": { "type": "string" } } }, { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 403 ] }, "code": { "type": "string", "enum": [ "forbidden" ] }, "message": { "type": "string" } } } ] } ``` ### 404: The domain was not found in our system. Content-Type: `application/json` ```json { "type": "object", "description": "The domain was not found in our system.", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 404 ] }, "code": { "type": "string", "enum": [ "domain_not_found" ] }, "message": { "type": "string" } } } ``` ### 429: TooManyRequests Content-Type: `application/json` ```json { "type": "object", "required": [ "status", "code", "message", "retryAfter", "limit" ], "properties": { "status": { "type": "number", "enum": [ 429 ] }, "code": { "type": "string", "enum": [ "too_many_requests" ] }, "message": { "type": "string" }, "retryAfter": { "type": "object", "required": [ "value", "str" ], "properties": { "value": { "type": "number" }, "str": { "type": "string" } } }, "limit": { "type": "object", "required": [ "total", "remaining", "reset" ], "properties": { "total": { "type": "number" }, "remaining": { "type": "number" }, "reset": { "type": "number" } } } } } ``` ### 500: InternalServerError Content-Type: `application/json` ```json { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "number", "enum": [ 500 ] }, "code": { "type": "string", "enum": [ "internal_server_error" ] }, "message": { "type": "string" } } } ``` --- ## Related - [domains-registrar endpoints](/docs/rest-api#domains-registrar) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)