Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ApplePendingRenewalInfo

Index

Properties

Optional auto_renew_product_id

auto_renew_product_id: undefined | string

The product id the customer will downgrade/crossgrade to when the current subscription period is over. The product id the customer will downgrade/crossgrade to when the current subscription period is over.

Note: Present if the user is downgrading or crossgrading.

Note: Present if the user is downgrading or crossgrading.

auto_renew_status

auto_renew_status: "1" | "0"

1 - Subscription will auto-renew 0 - Customer turned off auto-renew 1 - Subscription will auto-renew 0 - Customer turned off auto-renew

Official Apple documentation

Official Apple documentation

Optional expiration_intent

expiration_intent: "1" | "2" | "3" | "4" | "5"

Reason subscription expired. Reason subscription expired.

1 - Customer cancelled their subscription 2 - Billing error such as payment information not valid 3 - Customer did not agree to price increase 4 - Product not available for purchase 5 - Unknown error

Note: Present for a receipt that contains an expired auto-renewable subscription.

Official Apple documentation

1 - Customer cancelled their subscription 2 - Billing error such as payment information not valid 3 - Customer did not agree to price increase 4 - Product not available for purchase 5 - Unknown error

Note: Present for a receipt that contains an expired auto-renewable subscription.

Official Apple documentation

Optional grace_period_expires_date

grace_period_expires_date: undefined | string

When Apple will stop automatically retrying to renew the expired subscription. When Apple will stop automatically retrying to renew the expired subscription.

Note: Present if in a grace period

Example: 2013-08-01 07:00:00 Etc/GMT

Note: Present if in a grace period

Example: 2013-08-01 07:00:00 Etc/GMT

Optional grace_period_expires_date_ms

grace_period_expires_date_ms: undefined | string

When Apple will stop automatically retrying to renew the expired subscription. When Apple will stop automatically retrying to renew the expired subscription.

Note: Present if in a grace period

Example: 1605232028848

Note: Present if in a grace period

Example: 1605232028848

Optional grace_period_expires_date_pst

grace_period_expires_date_pst: undefined | string

When Apple will stop automatically retrying to renew the expired subscription. When Apple will stop automatically retrying to renew the expired subscription.

Note: Present if in a grace period

Note: Present if in a grace period

Optional is_in_billing_retry_period

is_in_billing_retry_period: "0" | "1"

If auto-renewable subscription is actively trying to be automatically renewed by Apple. Check the {@link expires_intent}, {@link expires_intent} to determine if Apple is trying to renew before or after the subscription has expired. If the subscription has expired, you are going to need to think through the logic of Grace Periods. Read more about Grace Periods to learn more about them. If auto-renewable subscription is actively trying to be automatically renewed by Apple. Check the {@link expires_intent}, {@link expires_intent} to determine if Apple is trying to renew before or after the subscription has expired. If the subscription has expired, you are going to need to think through the logic of Grace Periods. Read more about Grace Periods to learn more about them.

1 - Apple is trying to renew the subscription. See grace_period_expires_date to determine when Apple will stop trying. 0 - Apple has stopped attempting to renew.

Note: Present if auto-renewable subscription has expired and Apple is or is not trying to renew it.

Official Apple documentation

1 - Apple is trying to renew the subscription. See grace_period_expires_date to determine when Apple will stop trying. 0 - Apple has stopped attempting to renew.

Note: Present if auto-renewable subscription has expired and Apple is or is not trying to renew it.

Official Apple documentation

Optional offer_code_ref_name

offer_code_ref_name: undefined | string

original_transaction_id

original_transaction_id: string

The transaction ID that identifies a full payment history for a customer paying for a subscription through all of the renewals, upgrades/downgrades. The transaction ID that identifies a full payment history for a customer paying for a subscription through all of the renewals, upgrades/downgrades.

More details

More details

Optional price_consent_status

price_consent_status: "0" | "1"

1 - customer accepted the price increase 0 - customer has not yet accepted the price increase 1 - customer accepted the price increase 0 - customer has not yet accepted the price increase

Note: Present if the customer was notified of price increase. When you enable a price increase for existing customers, Apple follows a schedule that it has set. View the schedule here in the section "Increase the price of an auto-renewable subscription".

See expiration_intent as the customer will have their subscription expire if they never accept the price increase.

Note: Present if the customer was notified of price increase. When you enable a price increase for existing customers, Apple follows a schedule that it has set. View the schedule here in the section "Increase the price of an auto-renewable subscription".

See expiration_intent as the customer will have their subscription expire if they never accept the price increase.

product_id

product_id: string

Product id this renewal information is referring to. Product id this renewal information is referring to.

Legend

  • Property

Generated using TypeDoc