Qodex.ai

Invoicing API v4

Number of APIs: 8

Use the Invoicing API to access data about your Akamai invoices and credit memos.

With this API, you can: - Develop your own tools to track invoice and credit memo files and keep others in your organization updated about their status, if you administer an Akamai-accelerated website. - Compare your invoices and credit memos with your monthly usage.

Note: You can retrieve the data back to April 2016. For the COMPUTE invoice source type, data is available from February 2024.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

Note: Only Akamai customers can create credentials. If you aren't an Akamai customer and wish to become one, you can sign up for our services.

  1. Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

  1. Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

  1. Open the downloaded file with a text editor and add [default] as a header above all text.
  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj
  1. Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

  • To access your monthly usage over the Akamai network, use the Billing API.
  • Some API operations require a contractId identifier which you can access via the Contract API. The Invoicing API enables you to access any contract for which you have permission to view invoicing data.

Integration methods

You can use this API collection in these integration methods: - API

  1. Invoices - List invoices and credit memos for a contract GET https://{{host}}/invoicing-api/v4/contracts/:contractId/invoices?month={{month}}

  2. Invoices - Download an invoice or a credit memo file GET https://{{host}}/invoicing-api/v4/contracts/:contractId/invoices/:invoiceId/download

  3. Notifications - Create a notification POST https://{{host}}/invoicing-api/v4/notifications

  4. Notifications - List notifications for an account GET https://{{host}}/invoicing-api/v4/notifications

  5. Notifications - Get a notification GET https://{{host}}/invoicing-api/v4/notifications/:notificationId

  6. Notifications - Modify a notification PUT https://{{host}}/invoicing-api/v4/notifications/:notificationId

  7. Notifications - Remove a notification DELETE https://{{host}}/invoicing-api/v4/notifications/:notificationId

  8. Invoices - List invoices and credit memos for an account GET https://{{host}}/invoicing-api/v4/invoices?month={{month}}