Add failure information for the latest charge on a subscription

service/src/main/java/org/whispersystems/textsecuregcm/controllers/SubscriptionController.java

@@ -9,6 +9,8 @@ import static org.whispersystems.textsecuregcm.metrics.MetricsUtil.name;
 
 import com.codahale.metrics.annotation.Timed;
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.Strings;
 import com.stripe.model.Invoice;
@@ -615,6 +617,7 @@ public class SubscriptionController {
       private final BigDecimal amount;
       private final String status;
 
+      @JsonCreator
       public Subscription(
           @JsonProperty("level") long level,
           @JsonProperty("billingCycleAnchor") Instant billingCycleAnchor,
@@ -667,17 +670,46 @@ public class SubscriptionController {
       }
     }
 
+    public static class ChargeFailure {
+      private final String code;
+      private final String message;
+
+      @JsonCreator
+      public ChargeFailure(
+          @JsonProperty("code") String code,
+          @JsonProperty("message") String message) {
+        this.code = code;
+        this.message = message;
+      }
+
+      public String getCode() {
+        return code;
+      }
+
+      public String getMessage() {
+        return message;
+      }
+    }
+
     private final Subscription subscription;
+    private final ChargeFailure chargeFailure;
 
     @JsonCreator
     public GetSubscriptionInformationResponse(
-        @JsonProperty("subscription") Subscription subscription) {
+        @JsonProperty("subscription") Subscription subscription,
+        @JsonProperty("chargeFailure") ChargeFailure chargeFailure) {
       this.subscription = subscription;
+      this.chargeFailure = chargeFailure;
     }
 
     public Subscription getSubscription() {
       return subscription;
     }
+
+    @JsonInclude(Include.NON_NULL)
+    public ChargeFailure getChargeFailure() {
+      return chargeFailure;
+    }
   }
 
   @Timed
@@ -692,12 +724,21 @@ public class SubscriptionController {
         .thenApply(this::requireRecordFromGetResult)
         .thenCompose(record -> {
           if (record.subscriptionId == null) {
-            return CompletableFuture.completedFuture(Response.ok(new GetSubscriptionInformationResponse(null)).build());
+            return CompletableFuture.completedFuture(Response.ok(new GetSubscriptionInformationResponse(null, null)).build());
           }
           return stripeManager.getSubscription(record.subscriptionId).thenCompose(subscription ->
               stripeManager.getPriceForSubscription(subscription).thenCompose(price ->
-                  stripeManager.getLevelForPrice(price).thenApply(level -> Response.ok(
+                  stripeManager.getLevelForPrice(price).thenApply(level -> {
-                      new GetSubscriptionInformationResponse(new GetSubscriptionInformationResponse.Subscription(
+                    GetSubscriptionInformationResponse.ChargeFailure chargeFailure = null;
+                    if (subscription.getLatestInvoiceObject() != null && subscription.getLatestInvoiceObject().getChargeObject() != null &&
+                        (subscription.getLatestInvoiceObject().getChargeObject().getFailureCode() != null || subscription.getLatestInvoiceObject().getChargeObject().getFailureMessage() != null)) {
+                      chargeFailure = new GetSubscriptionInformationResponse.ChargeFailure(
+                          subscription.getLatestInvoiceObject().getChargeObject().getFailureCode(),
+                          subscription.getLatestInvoiceObject().getChargeObject().getFailureMessage());
+                    }
+                    return Response.ok(
+                        new GetSubscriptionInformationResponse(
+                            new GetSubscriptionInformationResponse.Subscription(
                                 level,
                                 Instant.ofEpochSecond(subscription.getBillingCycleAnchor()),
                                 Instant.ofEpochSecond(subscription.getCurrentPeriodEnd()),
@@ -705,8 +746,10 @@ public class SubscriptionController {
                                 subscription.getCancelAtPeriodEnd(),
                                 price.getCurrency().toUpperCase(Locale.ROOT),
                                 price.getUnitAmountDecimal(),
-                          subscription.getStatus()
+                                subscription.getStatus()),
-                      ))).build())));
+                            chargeFailure
+                        )).build();
+                  })));
         });
   }
 

service/src/main/java/org/whispersystems/textsecuregcm/stripe/StripeManager.java

@@ -245,8 +245,12 @@ public class StripeManager {
 
   public CompletableFuture<Subscription> getSubscription(String subscriptionId) {
     return CompletableFuture.supplyAsync(() -> {
+      SubscriptionRetrieveParams params = SubscriptionRetrieveParams.builder()
+          .addExpand("latest_invoice")
+          .addExpand("latest_invoice.charge")
+          .build();
       try {
-        return Subscription.retrieve(subscriptionId, commonOptions());
+        return Subscription.retrieve(subscriptionId, params, commonOptions());
       } catch (StripeException e) {
         throw new CompletionException(e);
       }