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}}
| Header | Type | Required | Description |
|---|---|---|---|
X-PARTNER-APIKEY | string | Yes | Partner Subscriptions API key for the authenticated Partner Subscriptions account. |
X-DC-DEVKEY | string | Yes | DigiCert 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.
X-PARTNER-APIKEY header and provide the DigiCert CertCentral® API key for the billing account in the X-DC-DEVKEY header.Billing and account linking
Every Partner Subscription is linked to a CertCentral account for billing. The pricing applied to your subscriptions is determined by the contract associated with the linked CertCentral account.
You can link a Partner Subscription account in one of the following ways:
- Link the Partner Subscription account to your parent partner CertCentral account.
- Link a Partner Subscription subaccount to the parent CertCentral account.
- Link a Partner Subscription subaccount to a specific CertCentral subaccount.
How pricing works for subaccounts
- If a Partner Subscription subaccount is not linked to its own billing account, it inherits the billing configuration of the parent account. In this case, the subaccount receives the parent account’s contract pricing.
- If a Partner Subscription subaccount is linked to a CertCentral account that does not have a contract, products purchased through that subaccount are billed at standard retail pricing.
Endpoints in this section
| Method | Endpoint | Description |
|---|---|---|
PUT | /finance/account-link | Link 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.
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 code | Description |
|---|---|
204 No Content | Billing account linked successfully. |
400 Bad Request | The request is missing required headers, includes invalid headers, or the provided DigiCert CertCentral® API key could not be resolved to a valid account. |
401 Unauthorized | Authentication failed. Check the Partner Subscriptions API key or DigiCert CertCentral® API key. |
403 Forbidden | Access denied. |