Update API Version

PATCHhttps://api.omise.co/account/api_version

Updates the default API version for the account. The API version determines response formats and available features. Use the List API Versions endpoint to discover available versions before updating.

Request Parameters

Required - 1 fieldRequired Parameters

▼

`api_version`STRING(required)

The API version to set as the default for the account. Must be a valid version returned by the List API Versions endpoint.

Example:"2019-05-29"

---

Responses

200

Successful update

Returns the updated account object with the new API version setting.

Updated account object contains:

• id - Account identifier
• api_version - Updated default API version
• email - Account email address
• country - Two-letter ISO 3166 country code
• currency - Three-letter ISO 4217 currency code
• All other account fields (webhook_uri, supported_currencies, etc.)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid API version specified
• Missing api_version parameter
• API version format is incorrect

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

The specified API version does not exist.

Common causes:

• API version string is not a valid version
• Typo in the version identifier
• Version has been deprecated and is no longer available

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/account/api_version \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "api_version=2019-05-29"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = Omise::Account.update_api_version(
  api_version: '2019-05-29'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = omise.Account.update_api_version(
    api_version='2019-05-29'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const account = await omise.account.updateApiVersion({
  api_version: '2019-05-29'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$account = OmiseAccount::updateApiVersion([
    'api_version' => '2019-05-29'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Account account = client.account().updateApiVersion()
    .apiVersion("2019-05-29")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var account = await client.Account.UpdateApiVersion(new UpdateApiVersionRequest
{
    ApiVersion = "2019-05-29"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

account, _ := client.Account().UpdateApiVersion(&operations.UpdateApiVersion{
    ApiVersion: "2019-05-29",
})

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

api_version(Required)

Your IP: ...Loading...