Finance management

Use the Finance Management endpoint to link a DigiCert CertCentral® billing account to the authenticated Partner Subscriptions account.

For an overview of the Partner Subscriptions API, see Partner Subscriptions API.

Why use it?

  • Link a DigiCert CertCentral® billing account to the authenticated Partner Subscriptions account.
  • Configure billing for a parent account or a subaccount.
  • Use the parent account’s billing account as a fallback when a subaccount does not have its own linked DigiCert CertCentral® billing account.

Resource URL

Use the Partner Subscriptions API finance resource URL to construct Finance Management requests.

https://www.digicert.com/partner-subscription/api/v1/finance/

Authentication and request headers

Finance Management endpoints require authentication with a Partner Subscriptions API key.

The account-link endpoint also requires a DigiCert CertCentral® API key for the billing account you want to link.

Request headers

Include these headers in the request:

X-PARTNER-APIKEY: {{partner_api_key}}
X-DC-DEVKEY: {{certcentral_api_key}}
HeaderTypeRequiredDescription
X-PARTNER-APIKEYstringYesPartner Subscriptions API key for the authenticated Partner Subscriptions account.
X-DC-DEVKEYstringYesDigiCert CertCentral® API key for the billing account you want to link.

A Partner Subscriptions API key is separate from a DigiCert CertCentral® API key. Partner Subscriptions API requests use the X-PARTNER-APIKEY header. DigiCert CertCentral® API requests use the X-DC-DEVKEY header.

For the account-link endpoint, you must include both headers.

Billing fallback

If a subaccount does not have a linked DigiCert CertCentral® billing account, it uses the parent account’s billing account.

To configure billing for a subaccount independently, authenticate with that subaccount’s Partner Subscriptions API key in the X-PARTNER-APIKEY header and provide the DigiCert CertCentral® API key for the billing account in the X-DC-DEVKEY header.

Endpoints in this section

MethodEndpointDescription
PUT/finance/account-linkLink a DigiCert CertCentral® billing account to the authenticated Partner Subscriptions account.

The endpoint uses the DigiCert CertCentral® API key provided in the X-DC-DEVKEY header to identify the billing account, then links it to the Partner Subscriptions account authenticated by the X-PARTNER-APIKEY header.

Make sure the DigiCert CertCentral® API key in the X-DC-DEVKEY header belongs to the billing account you want to link. If the API key cannot be resolved to a valid account, the request returns an error.

Requests

Finance Management requests use RESTful URLs and header-based authentication.

Method

Finance Management uses this standard HTTP method:

  • PUT

Responses

On success, the account-link endpoint returns 204 No Content.

Common response codes

Status codeDescription
204 No ContentBilling account linked successfully.
400 Bad RequestThe request is missing required headers, includes invalid headers, or the provided DigiCert CertCentral® API key could not be resolved to a valid account.
401 UnauthorizedAuthentication failed. Check the Partner Subscriptions API key or DigiCert CertCentral® API key.
403 ForbiddenAccess denied.