Object

responseBody.Pending_renewal_info

An array of elements that refers to auto-renewable subscription renewals that are open or failed in the past.

Properties

auto_renew_product_id
string

The current renewal preference for the auto-renewable subscription. The value for this key corresponds to the productIdentifier property of the product that the customer’s subscription renews. This field is only present if the user downgrades or crossgrades to a subscription of a different duration for the subsequent subscription period.

auto_renew_status

The current renewal status for the auto-renewable subscription. See auto_renew_status for more information.

expiration_intent

The reason a subscription expired. This field is only present for a receipt that contains an expired auto-renewable subscription.

grace_period_expires_date
string

The time at which the grace period for subscription renewals expires, in a date-time format similar to the ISO 8601.

grace_period_expires_date_ms
string

The time at which the grace period for subscription renewals expires, in UNIX epoch time format, in milliseconds. This key is only present for apps that have Billing Grace Period enabled and when the user experiences a billing error at the time of renewal. Use this time format for processing dates.

grace_period_expires_date_pst
string

The time at which the grace period for subscription renewals expires, in the Pacific Time zone.

is_in_billing_retry_period

A flag that indicates Apple is attempting to renew an expired subscription automatically. This field is only present if an auto-renewable subscription is in the billing retry state. See is_in_billing_retry_period for more information.

original_transaction_id

The transaction identifier of the original purchase.

price_consent_status
string

The price consent status for a subscription price increase. This field is only present if the customer was notified of the price increase. The default value is "0" and changes to "1" if the customer consents.

product_id
string

The unique identifier of the product purchased. You provide this value when creating the product in App Store Connect, and it corresponds to the productIdentifier property of the SKPayment object stored in the transaction's payment property.

Discussion

In the JSON file, pending_renewal_info is an array in which each element contains the pending renewal information for each auto-renewable subscription identified by the product_id. A pending renewal may refer to a renewal that is scheduled in the future or a renewal that failed in the past for some reason. It is only returned for app receipts that contain auto-renewable subscriptions.

You can use this value to get critical information about any pending renewal transactions for an auto-renewable subscription.