is now IAPTIC, please go to the new and better version of our system.

Customer Subscription API

GET /v2/customers/:applicationUsername/subscription
Get information about a customer’ subscription.


Response body

The /v2/customers/:applicationUsername/subscription request returns a JSON object containing the customer with the definition of its current subscription.

Property name Type Description
applicationUsername string User identifier from your application as specified in the store.order() call. See the applicationUsername documentation.
subscription object The subscription object. See below.


A subscription object.

Property name Type Description
transactionId string The transaction id of the latest recurring order associated with the purchase of the subscription.
productId string The unique identifier of the subscription product.
isExpired boolean Whether the subscription has expired. Value is true when no subscription products are currently owned. Check the cancelationReason field to know the reason why the subscription has expired.
expirationDate date-time Time at which the current (or last active) subscription is set to expire, in the ISO 8601 date-time format.
purchaseDate date-time Time at which the subscription was granted, in the ISO 8601 date-time format.
platform string Platform vendor that generated the receipt (apple, google, …)
sandbox boolean Whether the purchase was made in a sandbox or a production environment.
lastRenewalDate date-time The time the platform charged the user’s account for a purchased or restored product, in the ISO 8601 date-time format. (iOS only).
renewalIntent string Whether the customer intents to let a subscription be renewed when it reaches its current expiry time. Possible values:

  • Renew – The subscription will renew at the end of the current subscription period.
  • Lapse – The customer has turned off automatic renewal for the subscription. Check the cancelationReason field for details.
renewalIntentChangeDate date-string The time the customer or system change the renewalIntent status.
cancelationReason string The reason why a transaction was canceled, a subscription is not auto-renewing or expired. Possible values are:

  • Developer – Subscription canceled by the developer.
  • System – Subscription canceled by the system for an unspecified reason.
  • System.Replaced – Subscription upgraded or downgraded to a new subscription.
  • System.ProductUnavailable – Product not available for purchase at the time of renewal.
  • System.BillingError – Billing error; for example customer’s payment information is no longer valid.
  • Customer – Subscription canceled by the user for an unspecified reason.
  • Customer.TechnicalIssues – Customer canceled their transaction due to an actual or perceived issue within your app.
  • Customer.PriceIncrease – Customer did not agree to a recent price increase. See also priceConsentStatus.
  • Customer.Cost – Customer canceled for cost-related reasons.
  • Customer.FoundBetterApp – Customer claimed to have found a better app.
  • Customer.NotUsefulEnough – Customer did not feel he is using this service enough.
  • Customer.OtherReason – Subscription canceled for another reason; for example, if the customer made the purchase accidentally.
  • Unknown – Subscription canceled for unknown reasons.

You can use this value to display an alternative subscription product in your app, to win back the customer, such as a lower-level subscription plan to which the user can downgrade from their current plan. Consider presenting an attractive upgrade or downgrade offer.

isBillingRetryPeriod boolean Whether an auto-renewable subscription is in the billing retry period.

  • true – The platform is attempting to renew the subscription.
  • false – The platform has stopped attempting to renew the subscription.

This field indicates whether the platform is attempting to renew an expired subscription automatically. If the customer’s subscription failed to renew because the platform was unable to complete the transaction, this value reflects whether the platform is still trying to renew the subscription. You can use this field to:

  • Inform the user that there may be an issue with their billing information. For example, an expired credit card or insufficient balance could prevent this customer’s account from being billed.
  • Implement a grace period to improve recovery, if the value is true and the isExpired field is set. A grace period is free or limited subscription access while a subscriber is in a billing retry state.
isTrialPeriod boolean Whether a subscription is in the free trial period. Possible values are:

  • true – The subscription is in the free trial period
  • false – The subscription is not in the free trial period
isIntroPeriod boolean Whether an auto-renewable subscription is in the introductory price period.
promotionalOfferId string Identifier of the subscription offer redeemed by the user. (iOS only)
You provide this value in the Promotional Offer Product Code field when you create the subscription offer in App Store Connect. You can use this value to:

  • Confirm that the sale of the subscription was from a subscription offer.
  • Confirm which subscription offer was redeemed.
  • Keep track of the subscription offers that a user has redeemed to limit discounts you offer, according to your business model.
priceConsentStatus string Price consent status for a subscription price increase. Possible values:

  • Notified – Customer has been notified of the price increase but did not agree to it.
  • Agreed – Customer agreed to the price increase.
receiptId string Which receipt those subscription information are based upon. Check the Receipt API to learn more.
priceUSD number Price paid by the customer for the latest renewal, converted to U.S. Dollars.
priceMicros number Price paid by the customer for the latest renewal in the transaction currency, in micro unit. Divide by 1000000 for unit value.
currency string Currency in which the customer paid for the latest renewal.