How to access Hamlet and Gateway APIs (invoice, available-products)?

[Leo Nguyen]

Hi Atlassian team / community,

I'm currently trying to access some APIs that appear to be private or internal. Specifically:

1. GET https://www.atlassian.com/hamlet/1.0/public/order/{orderId}/summary
   → Seems to return invoice/order summary info. I get a 401Unauthorized error.

2. GET https://www.atlassian.com/gateway/api/available-products/api/available-products
   → Appears to list available products for a site. I cannot access it.

3. GET https://www.atlassian.com/hamlet/1.0/public/order/external/invoice/{orderId}/pdf
   → I assume this returns a PDF invoice file. Also blocked or inaccessible.

My questions:

• Are these APIs publicly accessible, or are they meant to be internal-only?

• Is there any documentation for them?

• What authentication method is required (e.g. OAuth scopes, Forge token, admin cookies)?

• Are there public alternatives for accessing billing data and available products?

Notes:

• I tested with Postman using admin session cookies.

• I couldn't find any mention of these endpoints on developer.atlassian.com.

Thanks in advance for any clarification or official guidance!

[Shannon S · Accepted solution]

Hi @Leo Nguyen,

Good day, and welcome to Atlassian Community! I'm Shannon, with the Community Support team. 

The API endpoints you're referring to are for internal use only, but I found there's a Commerce API you can use. You can authenticate with an Atlassian API token.

• Here's a link to that API: https://developer.atlassian.com/platform/commerce/rest/intro/ 

If you find what you need isn't here, we are looking into into the possibility of adding a more comprehensive billing API:

• COMMERCE-25  Ability to retrieve comprehensive billing information via REST API

You can add a comment to that feature sharing with our product team your use case and what you need the API to accomplish.

I hope this helps but let me know if you have any further questions!

Thanks,

Shannon S | Atlassian Community Support