List account settings

2 minute read

GET https://www.digicert.com/partner-subscription/api/v1/account/settings

Use this endpoint to retrieve all account settings for the authenticated Partner Subscriptions account.

Each setting includes the current value and indicates whether the account is using the system default or an account-specific override.

This endpoint returns account settings for the account authenticated by the X-PARTNER-APIKEY header. Use a parent account Partner Subscriptions API key to retrieve parent account settings. Use a subaccount Partner Subscriptions API key to retrieve settings for that subaccount.
The auto_renew_subscription setting controls the default auto-renewal behavior for new ACME contracts. When set to 1, new ACME contracts default to auto-renew enabled unless explicitly disabled during contract creation. When set to 0, new ACME contracts default to auto-renew disabled unless explicitly enabled during contract creation.

Example requests and responses

curl -X GET \
  https://www.digicert.com/partner-subscription/api/v1/account/settings \
  -H 'X-PARTNER-APIKEY: {{partner_api_key}}'

import requests

url = "https://www.digicert.com/partner-subscription/api/v1/account/settings"

headers = {
    'X-PARTNER-APIKEY': "{{partner_api_key}}"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/partner-subscription/api/v1/account/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-PARTNER-APIKEY", "{{partner_api_key}}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://www.digicert.com/partner-subscription/api/v1/account/settings',
  headers: {
    'X-PARTNER-APIKEY': '{{partner_api_key}}'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

200 OK

[
  {
    "name": "auto_renew_subscription",
    "value": "0",
    "is_default": true
  }
]

URL path and query parameters

This endpoint does not use URL path or query parameters.

Request parameters

This endpoint does not use request body parameters.

Response parameters

Name Type Description

name

string

Name of the account setting.

Supported settings:

Setting name	Valid values	Default	Description
`auto_renew_subscription`	`0`, `1`	`0`	Controls the default auto-renewal behavior for new ACME contracts. When set to `1`, new ACME contracts default to auto-renew enabled unless explicitly overridden at contract creation.

value string Current value of the account setting.

is_default boolean Indicates whether the account is using the system default value for the setting. Returns true when the account is using the system default and false when the account has a custom override.