2025-06-30
▼ ▲ merchantapi.accounts.programs.checkoutSettings.getCheckoutSettings
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
HTTP Method : GET
Parameters :
name
Description : Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`
Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings.
▼ ▲ merchantapi.accounts.programs.checkoutSettings.create
Path : accounts/v1beta/{+parent}/checkoutSettings
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
HTTP Method : POST
Parameters :
parent
Description : Required. The merchant account for which the `CheckoutSettings` will be created.
Pattern : ^accounts/[^/]+/programs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : Creates `CheckoutSettings` for the given merchant.
▼ ▲ merchantapi.accounts.programs.checkoutSettings.updateCheckoutSettings
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Updates `CheckoutSettings` for the given merchant.
▼ ▲ merchantapi.accounts.programs.checkoutSettings.deleteCheckoutSettings
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
HTTP Method : DELETE
Parameters :
name
Description : Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`
Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.