REST Resource: accounts.termsOfServiceAgreementStates

Resource: TermsOfServiceAgreementState

This resource represents the agreement state for a given account and terms of service kind. The state is as follows:

  • If the merchant has accepted a terms of service: accepted will be populated, otherwise it will be empty
  • If the merchant must sign a terms of service: required will be populated, otherwise it will be empty.

Note that both required and accepted can be present. In this case the accepted terms of services will have an expiration date set in the validUntil field. The required terms of services need to be accepted before validUntil in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as tosFileUri. The actual acceptance of the terms of service is done by calling accept on the TermsOfService resource.

JSON representation 
{
  "name": string,
  "regionCode": string,
  "termsOfServiceKind": enum (TermsOfServiceKind),
  "accepted": {
    object (Accepted)
  },
  "required": {
    object (Required)
  }
}
Fields
name

string

Identifier. The resource name of the terms of service version. Format: accounts/{account}/termsOfServiceAgreementState/{identifier} The identifier format is: {TermsOfServiceKind}-{country} For example, an identifier could be: MERCHANT_CENTER-US
regionCode

string

Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.
termsOfServiceKind

enum (TermsOfServiceKind)

Terms of Service kind associated with the particular version.
accepted

object (Accepted)

The accepted terms of service of this kind and for the associated regionCode
required

object (Required)

The required terms of service

Accepted

Describes the accepted terms of service.

JSON representation 
{
  "termsOfService": string,
  "acceptedBy": string,
  "validUntil": {
    object (Date)
  }
}
Fields
termsOfService

string

The accepted termsOfService.
acceptedBy

string

The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the MCA account.
validUntil

object (Date)

When set, it states that the accepted TermsOfService is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required TermsOfService is found in the Required message.

Required

Describes the terms of service which are required to be accepted.

JSON representation 
{
  "termsOfService": string,
  "tosFileUri": string
}
Fields
termsOfService

string

The termsOfService that need to be accepted.
tosFileUri

string

Full URL to the terms of service file. This field is the same as TermsOfService.file_uri, it is added here for convenience only.

Methods

get

 Returns the state of a terms of service agreement.

retrieveForApplication

 Retrieves the state of the agreement for the application terms of service.