Changelog

Data Plan Agent API

September 2018

  1. Added API to report user consent to operators.
  2. Added support for plans that periodically refresh their quota.
  3. Added support for expiry notifications.
  4. Renamed PlanModuleState to PlanState. This is a documentation change that should not affect operators.

August 2018

  1. Added the ability for carriers to specify account balance as part of a PlanStatus.

June 2018

  1. Removed update, get methods for plan status and plan offers.
  2. Allowed coarse balance level to be populated at the same time when byte balance or time balance are populated.
  3. Added connection type to an Offer.
  4. Added plan module state field to PlanModule to allow an operator to indicate plans which the user has bought but have not been activated yet. This is not a required field.
  5. DataPlan renamed to Plan. This is a documentation change that should not affect operators.
  6. Added formOfPayment field to PlanOffer allowing an operator to specify how the user will be charged for the purchase. This defaults to deducted from plan balance.

May 2018

  1. Updated CPID response to keep the response backwards compatible.
  2. Added title for a PlanStatus. The title will be used to populate the header in the settings UI.
  3. Added module name and used bytes for a PlanModule.
  4. Added a purchase response call back to GTAF.

March 2018

This update includes the following changes to the Data Plan Agent API. These changes are relative to Data Plan API v4.2 hosted here.

  1. Deprecates the following API calls:
    1. Querying user account (DPA_URL/{data_plan_key_string}/account).
    2. Querying purchased plans (DPA_URL/{data_plan_key_string}/purchasedPlans).
  2. Changes the URL we call for data plan status. The new URL is described here. The DPA is expected to return an instance of PlanStatus.
  3. Changes the URL we call for plan offers. The new URL is described here. The DPA is expected to return an instance of PlanOffer.
  4. Changes the body of the request sent to DPA when purchasing a plan. Note that API call is the same. The body of the request now contains an instance of TransactionRequest. Note the removal of a level of nesting compared to the previous version of the API.
  5. Response to a purchase request has changed. We take advantage of currency type defined by Google protobuf. In response to a successful purchase, we expect the response body to contain an instance of TransactionResponse.
  6. If a plan_id is not specified, then the eligibility API MUST return all the data plans that the user is eligible for. Previously this was optional.
  7. Adds an MSISDN registration endpoint for GTAF to register MSISDNs for notifications with the DPA.

Google Mobile Data Plan Sharing API

March 2018

This update includes the following changes to the Google Mobile Data Plan Sharing API:

  1. Introduces new API calls allowing an operator to push upsell offer information to GTAF to be pushed further down to user devices. These new calls allow an operator to push PlanOffers.
  2. Introduces a last updated time field in a PlanGroup.
  3. Removes data credit percentage field from flex time window.