Scrip v1.0.0 Scrip.PendingRenewalInfo View Source

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

Only returned for app receipts that contain auto-renewable subscriptions.

See https://developer.apple.com/documentation/appstorereceipts/responsebody/pending_renewal_info

Link to this section Summary

Types

The renewal status for the auto-renewable subscription.

An indicator of whether an auto-renewable subscription is in the billing retry period.

t()

Refers to auto-renewable subscription renewals that are open or failed in the past.

Functions

Converts response map to %Elixir.Scrip.PendingRenewalInfo struct

Link to this section Types

Specs

auto_renew_status() :: boolean()

The renewal status for the auto-renewable subscription.

Possible Values

true The subscription will renew at the end of the current subscription period.

false The customer has turned off automatic renewal for the subscription.

See: https://developer.apple.com/documentation/appstorereceipts/auto_renew_status

Link to this type

is_in_billing_retry_period()

View Source

Specs

is_in_billing_retry_period() :: boolean()

An indicator of whether an auto-renewable subscription is in the billing retry period.

Possible Values

true The App Store is attempting to renew the subscription.

false The App Store has stopped attempting to renew the subscription.

See: https://developer.apple.com/documentation/appstorereceipts/is_in_billing_retry_period

Specs

t() :: %Scrip.PendingRenewalInfo{
  auto_renew_product_id: String.t(),
  auto_renew_status: auto_renew_status(),
  expiration_intent: 1..5,
  is_in_billing_retry_period: is_in_billing_retry_period(),
  original_transaction_id: String.t(),
  product_id: String.t()
}

Refers to auto-renewable subscription renewals that are open or failed in the past.

See: https://developer.apple.com/documentation/appstorereceipts/responsebody/pending_renewal_info#properties

Link to this section Functions

Link to this function

%Scrip.PendingRenewalInfo{}

View Source (struct)

The Elixir.Scrip.PendingRenewalInfo struct

Contains the auto-renewable subscription renewals that are open or failed in the past.

Specs

new(response :: map()) :: t()

Converts response map to %Elixir.Scrip.PendingRenewalInfo struct