REST Resource: accounts.programs.ucpSettings

Resource: UcpSettings

Represents the Universal Commerce Protocol (UCP) enablement state and configuration for a Merchant Center account. For setup instructions, see the UCP checkout setup guide.

UcpSettings (accounts.programs.ucpSettings) stores the persistent, validated UCP configuration and parsed profile for the ucp-integration program. Updating this resource with ucpSettings.updateUcpSettings starts an asynchronous validation of the wellKnownUri and returns a separate Operation resource (accounts.programs.ucpSettings.operations). Poll the operation using operations.get until done is true to verify whether validation succeeded and the updated UcpSettings were stored.

JSON representation 
{
  "name": string,
  "wellKnownUri": string,
  "updateTime": string,
  "ucpProfile": {
    object (UcpProfile)
  }
}
Fields
name

string

Identifier. The resource name of the UcpSettings. Format: accounts/{account}/programs/{program}/ucpSettings. The only supported {program} value is ucp-integration (for example, accounts/123456/programs/ucp-integration/ucpSettings).
wellKnownUri

string

Optional. The public Universal Commerce Protocol (UCP) profile URL (e.g., https://example.com/.well-known/ucp). This URI must be publicly accessible and not require any authentication.
updateTime

string (Timestamp format)

Output only. The timestamp when the UCP settings were last successfully patched.
ucpProfile

object (UcpProfile)

Output only. The UCP profile contents fetched from the business's wellKnownUri.

UcpProfile

Represents the parsed contents of a business's UCP profile.

JSON representation 
{
  "version": string,
  "capabilities": [
    string
  ],
  "paymentHandlers": [
    string
  ],
  "signingKeys": [
    string
  ]
}
Fields
version

string

Output only. The version of the UCP specification used by the profile (e.g., "2026-01-23").
capabilities[]

string

Output only. The list of UCP core capabilities supported by the business (e.g., "dev.ucp.common.checkout").
paymentHandlers[]

string

Output only. The list of payment handler specifiers supported by the business (e.g., "com.google.pay").
signingKeys[]

string

Output only. The list of key identifiers used by the business to sign cryptographic mandates.

Methods

getUcpSettings

 Retrieves the currently stored, validated UcpSettings for a Merchant Center account.

updateUcpSettings

 Patches the UCP settings for a Merchant Center account.