Uploaded image for project: 'Commerce'
  1. Commerce
  2. COMMERCE-86

Expose Subscription Plan Details, Billing Frequency, and User Count in Commerce (PPC) APIs

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Issue Summary

      Create API endpoints to retrieve subscription data for a specific Atlassian customer site or user (e.g., list of subscriptions and associated plan details).
      Using Atlassian’s Commerce (PPC) APIs, we require more detailed subscription data in order to support licensing workflows, customer reporting, and usage-based billing. While the current endpoint

      GET https://api.atlassian.com/commerce/api/v1/entitlements 

      Expected Results

      An authenticated vendor should be able to use an API to retrieve:

      • A list of subscriptions tied to a specific Atlassian customer site or account
      • Subscription metadata, such as product, plan (Free, Standard, Premium), and renewal status
      • Customer identifiers such as cloud site ID or account ID

      This would support vendors in providing more tailored support, reporting, or automation based on customer subscription levels.

      Actual Results

       

      There are currently no public APIs that:
      
      
      Return a customer's list of product subscriptions (across Atlassian products or third-party apps)
      
      
      Provide plan or billing tier information tied to a specific site or user
      

      Workaround

      Required, if there is no workaround please state:
      Currently, there is no known workaround for this behavior.

            [COMMERCE-86] Expose Subscription Plan Details, Billing Frequency, and User Count in Commerce (PPC) APIs

            Yuvie Naidoo made changes -
            Description Original: h3. Issue Summary

            Create API endpoints to retrieve *subscription data* for a specific Atlassian customer site or user (e.g., list of subscriptions and associated plan details).
            h3. Expected Results

            An authenticated vendor should be able to use an API to retrieve:
             * A list of subscriptions tied to a specific Atlassian customer site or account

             * Subscription metadata, such as product, plan (Free, Standard, Premium), and renewal status

             * Customer identifiers such as cloud site ID or account ID

            This would support vendors in providing more tailored support, reporting, or automation based on customer subscription levels.
            h3. Actual Results

             
            {noformat}
            There are currently no public APIs that:


            Return a customer's list of product subscriptions (across Atlassian products or third-party apps)


            Provide plan or billing tier information tied to a specific site or user


            Only license and transaction data for individual apps (from the vendor's perspective) are accessible via:


            /reporting/licenses


            /reporting/sales/transactions


            This makes it difficult for Marketplace vendors to programmatically understand the broader subscription context of their customers. {noformat}
            h3. Workaround

            Required, if there is no workaround please state:
            Currently, there is no known workaround for this behavior. Vendors must rely on license data and transaction metadata, which do not include subscription or plan-level detail. A workaround will be added here when available.
            New: h3. Issue Summary

            Create API endpoints to retrieve *subscription data* for a specific Atlassian customer site or user (e.g., list of subscriptions and associated plan details).
            Using Atlassian’s Commerce (PPC) APIs, we require more detailed subscription data in order to support licensing workflows, customer reporting, and usage-based billing. While the current endpoint
            {code:java}
            GET https://api.atlassian.com/commerce/api/v1/entitlements {code}
            h3. Expected Results

            An authenticated vendor should be able to use an API to retrieve:
             * A list of subscriptions tied to a specific Atlassian customer site or account

             * Subscription metadata, such as product, plan (Free, Standard, Premium), and renewal status

             * Customer identifiers such as cloud site ID or account ID

            This would support vendors in providing more tailored support, reporting, or automation based on customer subscription levels.
            h3. Actual Results

             
            {noformat}
            There are currently no public APIs that:


            Return a customer's list of product subscriptions (across Atlassian products or third-party apps)


            Provide plan or billing tier information tied to a specific site or user
            {noformat}
            h3. Workaround

            Required, if there is no workaround please state:
            Currently, there is no known workaround for this behavior.
            Summary Original: Create API endpoints to retrieve subscription data New: Expose Subscription Plan Details, Billing Frequency, and User Count in Commerce (PPC) APIs
            Yuvie Naidoo made changes -
            Labels New: ecohelp rest-api
            Yuvie Naidoo created issue -

              Unassigned Unassigned
              dac88f2c0f98 Yuvie Naidoo
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: