Optional override for formatting stack traces
The reason a subscription expired.
Billing error; for example, the customer's payment information was no longer valid.
-The customer voluntarily canceled their subscription.
-The customer did not agree to a recent price increase.
-The product was not available for purchase at the time of renewal.
-Unknown Error.
Generated using TypeDoc
The type that describes the in-app purchase event for which the App Store sent the notification.
Indicates that either Apple customer support canceled the auto-renewable subscription or the user upgraded their auto-renewable subscription. The cancellation_date key contains the date and time of the change.
-Indicates that the customer made a change in their subscription plan that takes effect at the next renewal. The currently active plan isn’t affected.
-Indicates a change in the subscription renewal status. In the JSON response, check auto_renew_status_change_date_ms to know the date and time of the last status update. Check auto_renew_status to know the current renewal status.
-Indicates a subscription that failed to renew due to a billing issue. Check is_in_billing_retry_period to know the current retry status of the subscription. Check grace_period_expires_date to know the new service expiration date if the subscription is in a billing grace period.
-Indicates a successful automatic renewal of an expired subscription that failed to renew in the past. Check InAppPurchaseTransaction.expires_date to determine the next renewal date and time.
-Indicates that a customer’s subscription has successfully auto-renewed for a new transaction period.
-Occurs at the user’s initial purchase of the subscription. Store UnifiedReceipt.latest_receipt on your server as a token to verifyReceipt the user’s subscription status at any time by validating it with the App Store.
-Indicates the customer renewed a subscription interactively, either by using your app’s interface, or on the App Store in the account’s Subscriptions settings. Make service available immediately.
-Indicates that App Store has started asking the customer to consent to your app’s subscription price increase. In the UnifiedReceipt.pending_renewal_info object, the price_consent_status value is 0, indicating that App Store is asking for the customer’s consent, and hasn't received it. The subscription won’t auto-renew unless the user agrees to the new price. When the customer agrees to the price increase, the system sets price_consent_status to 1. Check the receipt using verifyReceipt to view the updated price-consent status.
-Indicates that App Store successfully refunded a transaction for a consumable or non-consumable in-app purchase. The InAppPurchaseTransaction.cancellation_date_ms contains the timestamp of the refunded transaction. The InAppPurchaseTransaction.original_transaction_id and product_id identify the original transaction and product. The InAppPurchaseTransaction.cancellation_reason contains the reason.
-Indicates successful automatic renewal of an expired subscription that failed to renew in the past. Check InAppPurchaseTransaction.expires_date to determine the next renewal date and time.
Update your existing code to rely on the DID_RECOVER notification type instead.
As of March 10, 2021 this notification is no longer sent in production and sandbox environments.
-Indicates that an in-app purchase the user was entitled to through Family Sharing is no longer available through sharing.
The error statuses for the app receipt verification.
The user account cannot be found or has been deleted.
-Internal data access error. Try again later.
-The data in the receipt-data property was malformed or the service experienced a temporary issue. Try again.
-The request to the App Store was not made using the HTTP POST request method.
-The receipt server was temporarily unable to provide the receipt. Try again.
-The shared secret you provided does not match the shared secret on file for your account.
-This status code is no longer sent by the App Store.
-This status code is no longer sent by the App Store.
+The receipt could not be authenticated.
-This receipt is from the production environment, but it was sent to the test environment for verification.
-This receipt is from the test environment, but it was sent to the production environment for verification.
Generated using TypeDoc
The success statuses for the app receipt verification.
This receipt is valid but the subscription has expired. When this status code is returned to your server, the receipt data is also decoded and returned as part of the response. Only returned for iOS 6-style transaction receipts for auto-renewable subscriptions.
-The value for status is 0 if the receipt is valid.
Generated using TypeDoc
Use the UnifiedReceipt.latest_receipt_info object instead.
This object is deprecated in the sandbox and production environments, and no longer included in the response body as of March 10, 2021.
-An identifier that App Store Connect generates and the App Store uses to uniquely identify the app purchased. Treat this value as a 64-bit integer.
-The time a subscription expires or when it will renew, in UNIX epoch time format, in milliseconds. Use this time format for processing dates. Note that this field is called expires_date_ms in the transaction.
1616411598724
-The time a subscription expires or when it will renew, in the Pacific time zone. Note that this field is called expires_date_pst in the transaction.
2021-01-01 00:00:00 America/Los_Angeles
-An indicator of whether an auto-renewable subscription is in the introductory price period.
An indicator of whether a subscription is in the free trial period.
An identifier that App Store Connect generates and the App Store uses to uniquely identify the in-app product purchased. Treat this value as a 64-bit integer.
-The time of the original app purchase, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time of the original app purchase, in UNIX epoch time format, in milliseconds. Use this time format for processing dates. This value indicates the date of the subscription's initial purchase. The original purchase date applies to all product types and remains the same in all transactions for the same product ID. This value corresponds to the original transaction’s transactionDate property in StoreKit.
1616411598724
-The time of the original app purchase, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The transaction identifier of the original purchase.
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.
-The time the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in the UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-The time the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The number of consumable products purchased. This value corresponds to the quantity property of the SKPayment object stored in the transaction’s payment property. The value is usually '1' unless modified with a mutable payment. The maximum value is '10'.
-A unique identifier for a transaction such as a purchase, restore, or renewal.
Generated using TypeDoc
The in-app purchase receipt fields for all in-app purchase transactions.
The time when Apple customer support canceled a transaction, in a date-time format similar to the ISO 8601. This field is only present for refunded transactions.
2013-08-01 07:00:00 Etc/GMT
-The time when Apple customer support canceled a transaction, or the time when the user upgraded an auto-renewable subscription plan, in UNIX epoch time format, in milliseconds. This field is only present for refunded transactions. Use this time format for processing dates.
1616411598724
-The time when Apple customer support canceled a transaction, in the Pacific Time zone. This field is only present for refunded transactions.
2021-01-01 00:00:00 America/Los_Angeles
-The reason for a refunded transaction. When a customer cancels a transaction, the App Store gives them a refund and provides a value for this key.
1 - the customer canceled their transaction due to an actual or perceived issue within your app. 0 - the transaction was canceled for another reason; for example, if the customer made the purchase accidentally.
-The time when a subscription expires or when it will renew, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.
2021-03-01 07:00:00 Etc/GMT
-The time when a subscription expires or when it will renew, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-The time when a subscription expires or when it will renew, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-A value that indicates whether the user is the purchaser of the product, or is a family member with access to the product through Family Sharing.
An indicator of whether an auto-renewable subscription is in the introductory price period.
An indicator of whether a subscription is in the free trial period.
The time of the original app purchase, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time of the original app purchase, in UNIX epoch time format, in milliseconds. Use this time format for processing dates. This value indicates the date of the subscription’s initial purchase. The original purchase date applies to all product types and remains the same in all transactions for the same product ID. This value corresponds to the original transaction's transactionDate property in StoreKit.
1616411598724
-The time of the original app purchase, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The transaction identifier of the original purchase.
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.
-The identifier of the subscription offer redeemed by the user.
The time when the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time when the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in the UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-The time when the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The number of consumable products purchased. This value corresponds to the quantity property of the SKPayment object stored in the transaction's payment property. The value is usually '1' unless modified with a mutable payment. The maximum value is '10'.
-A unique identifier for a transaction such as a purchase, restore, or renewal.
Generated using TypeDoc
An object that contains information about the latest in-app subscription transaction.
The time when Apple customer support canceled a transaction, in a date-time format similar to the ISO 8601. This field is only present for refunded transactions.
2013-08-01 07:00:00 Etc/GMT
-The time when Apple customer support canceled a transaction, or the time when the user upgraded an auto-renewable subscription plan, in UNIX epoch time format, in milliseconds. This field is only present for refunded transactions. Use this time format for processing dates.
1616411598724
-The time when Apple customer support canceled a transaction, in the Pacific Time zone. This field is only present for refunded transactions.
2021-01-01 00:00:00 America/Los_Angeles
-The reason for a refunded transaction. When a customer cancels a transaction, the App Store gives them a refund and provides a value for this key.
1 - the customer canceled their transaction due to an actual or perceived issue within your app. 0 - the transaction was canceled for another reason; for example, if the customer made the purchase accidentally.
-The time when a subscription expires or when it will renew, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.
2021-03-01 07:00:00 Etc/GMT
-The time when a subscription expires or when it will renew, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-The time when a subscription expires or when it will renew, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-A value that indicates whether the user is the purchaser of the product, or is a family member with access to the product through Family Sharing.
An indicator of whether an auto-renewable subscription is in the introductory price period.
An indicator of whether a subscription is in the free trial period.
An indicator that the system canceled a subscription because the user upgraded. This field is only present for upgrade transactions.
-The reference name of a subscription offer you configured in App Store Connect. This field is present when a customer redeemed a subscription offer code.
The time of the original app purchase, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time of the original app purchase, in UNIX epoch time format, in milliseconds. Use this time format for processing dates. This value indicates the date of the subscription’s initial purchase. The original purchase date applies to all product types and remains the same in all transactions for the same product ID. This value corresponds to the original transaction's transactionDate property in StoreKit.
1616411598724
-The time of the original app purchase, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The transaction identifier of the original purchase.
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.
-The identifier of the subscription offer redeemed by the user.
The time when the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time when the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in the UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-The time when the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The number of consumable products purchased. This value corresponds to the quantity property of the SKPayment object stored in the transaction's payment property. The value is usually '1' unless modified with a mutable payment. The maximum value is '10'.
-The identifier of the subscription group to which the subscription belongs. The value for this field is identical to the subscriptionGroupIdentifier property in SKProduct.
-A unique identifier for a transaction such as a purchase, restore, or renewal.
Generated using TypeDoc
Elements that refers to open auto-renewable subscription renewals or ones that failed in the past.
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 cross-grades to a subscription of a different duration for the subsequent subscription period.
-The current renewal status for the auto-renewable subscription.
1 - Subscription will auto-renew 0 - Customer turned off auto-renew
The reason a subscription expired. This field is only present for a receipt that contains an expired auto-renewable subscription.
-The time at which the grace period for subscription renewals expires, in a date-time format similar to the ISO 8601.
2021-03-01 07:00:00 Etc/GMT
-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.
1616411598724
-The time at which the grace period for subscription renewals expires, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-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.
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.
The reference name of a subscription offer that you configured in App Store Connect. This field is present when a customer redeemed a subscription offer code.
The transaction identifier of the original purchase.
-The price consent status for a subscription price increase. This field is only present if the customer was notified of the price increase.
1 - customer accepted the price increase 0 - customer has not yet accepted the price increase
-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.
-The identifier of the promotional offer for an auto-renewable subscription that the user redeemed. You provide this value in the Promotional Offer Identifier field when you create the promotional offer in App Store Connect.
diff --git a/docs/interfaces/receipt.html b/docs/interfaces/receipt.html index 73a9a0f..a7d3031 100644 --- a/docs/interfaces/receipt.html +++ b/docs/interfaces/receipt.html @@ -1,88 +1,88 @@The decoded version of the encoded receipt data sent with the request to the App Store.
See app_item_id.
-Generated by App Store Connect and used by the App Store to uniquely identify the app purchased. Apps are assigned this identifier only in production. Treat this value as a 64-bit long integer.
-The app's version number. The app's version number corresponds to the value of CFBundleVersion (in iOS) or CFBundleShortVersionString (in macOS) in the Info.plist. In production, this value is the current version of the app on the device based on the receipt_creation_date_ms. In the sandbox, the value is always '1.0'.
-The bundle identifier for the app to which the receipt belongs. You provide this string on App Store Connect. This corresponds to the value of CFBundleIdentifier in the Info.plist file of the app.
-A unique identifier for the app download transaction.
-The time the receipt expires for apps purchased through the Volume Purchase Program, in a date-time format similar to the ISO 8601.
2021-03-01 07:00:00 Etc/GMT
-The time the receipt expires for apps purchased through the Volume Purchase Program, in UNIX epoch time format, in milliseconds. If this key is not present for apps purchased through the Volume Purchase Program, the receipt does not expire. Use this time format for processing dates.
1616411598724
-The time the receipt expires for apps purchased through the Volume Purchase Program, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-An array that contains the in-app purchase receipt fields for all in-app purchase transactions.
-The version of the app that the user originally purchased. This value does not change, and corresponds to the value of CFBundleVersion (in iOS) or CFBundleShortVersionString (in macOS) in the Info.plist file of the original purchase. In the sandbox environment, the value is always '1.0'.
-The time of the original app purchase, in a date-time format similar to ISO 8601.
2021-03-01 07:00:00 Etc/GMT
-The time of the original app purchase, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-The time of the original app purchase, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The time the user ordered the app available for pre-order, in a date-time format similar to ISO 8601. Only present if the app was ordered through pre-order.
2021-03-01 07:00:00 Etc/GMT
-The time the user ordered the app available for pre-order, in UNIX epoch time format, in milliseconds. This field is only present if the user pre-orders the app. Use this time format for processing dates.
1616411598724
-The time the user ordered the app available for pre-order, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The time the App Store generated the receipt, in a date-time format similar to ISO 8601.
2021-03-01 07:00:00 Etc/GMT
-The time the App Store generated the receipt, in UNIX epoch time format, in milliseconds. Use this time format for processing dates. This value does not change.
1616411598724
-The time the App Store generated the receipt, in the Pacific Time zone.
2021-01-01 00:00:00 America/Los_Angeles
-The type of receipt generated. The value corresponds to the environment in which the app or VPP purchase was made.
-The time the request to the verifyReceipt endpoint was processed and the response was generated, in a date-time format similar to ISO 8601.
2021-03-01 07:00:00 Etc/GMT
-The time the request to the verifyReceipt endpoint was processed and the response was generated, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.
1616411598724
-Generated using TypeDoc
The JSON data sent in the server notification from the App Store.
An identifier that App Store Connect generates and the App Store uses to uniquely identify the auto-renewable subscription that the user’s subscription renews. Treat this value as a 64-bit integer.
-The product identifier of the auto-renewable subscription that the user’s subscription renews.
-The current renewal status for an auto-renewable subscription product. Note that these values are different from those of the auto_renew_status in the receipt.
-The time at which the user turned on or off the renewal status for an auto-renewable subscription, in a date-time format similar to the ISO 8601 standard.
2021-03-01 07:00:00 Etc/GMT
-The time at which the user turned on or off the renewal status for an auto-renewable subscription, in UNIX epoch time format, in milliseconds. Use this time format to process dates.
1616411598724
-The time at which the user turned on or off the renewal status for an auto-renewable subscription, in the Pacific time zone.
2021-01-01 00:00:00 America/Los_Angeles
-A string that contains the app bundle ID.
-A string that contains the app bundle version.
-The environment for which App Store generated the receipt.
-The reason a subscription expired. This field is only present for an expired auto-renewable subscription.
-The latest expired Base64-encoded app receipt.
As of March 10, 2021 this object is no longer provided in production and sandbox environments. Use latest_receipt in the unified_receipt object instead.
-The latest decoded app receipts.
As of March 10, 2021 this object is no longer provided in production and sandbox environments. Use unified_receipt.Latest_receipt_info in the unified_receipt object instead.
-The latest Base64-encoded app receipt.
As of March 10, 2021 this object is no longer provided in production and sandbox environments. Use the latest_receipt field found in the unified_receipt object instead.
-The latest decoded app receipt.
As of March 10, 2021 this object is no longer provided in production and sandbox environments. Use unified_receipt.Latest_receipt_info in the unified_receipt object instead.
-The subscription event that triggered the notification.
-The same value as the shared secret you submit in the password field of the requestBody when validating receipts.
-An object that contains information about the most-recent, in-app purchase transactions for the app.
Generated using TypeDoc
An object that contains information about the most-recent, in-app purchase transactions for the app.
The environment for which App Store generated the receipt.
-The latest Base64-encoded app receipt.
-An array that contains the latest 100 in-app purchase transactions of the decoded value in latest_receipt. This array excludes transactions for consumable products your app has marked as finished. The contents of this array are identical to those in VerifyReceiptResponseSuccess.latest_receipt_info in the verifyReceipt endpoint response for receipt validation.
-An array where each element contains the pending renewal information for each auto-renewable subscription identified in product_id. The contents of this array are identical to those in VerifyReceiptResponseSuccess.latest_receipt_info in the verifyReceipt endpoint response for receipt validation.
-The status code, where 0 indicates that the notification is valid.
Generated using TypeDoc
The JSON contents you submit with the verifyReceipt request to the App Store.
Set this value to true for the response to include only the latest renewal transaction for any subscriptions. Use this field only for app receipts that contain auto-renewable subscriptions.
-Your app’s shared secret, which is a hexadecimal string.
-The Base64-encoded receipt data.
Generated using TypeDoc
The response body of a request that had an error. The receipt was not decoded and returned.
-An indicator that an error occurred during the request.
1 - a temporary issue; retry validation for this receipt at a later time. 0 - an unresolvable issue; do not retry validation for this receipt.
Only applicable to status codes 21100-21199
-An VerifyReceiptErrorStatus status code if there is an error. The status code reflects the status of the app receipt as a whole.
Generated using TypeDoc
The response body of a request that had was successful.
-The environment for which the receipt was generated.
-The latest Base64 encoded app receipt. Only returned for receipts that contain auto-renewable subscriptions.
-An array that contains all in-app purchase transactions. This excludes transactions for consumable products that have been marked as finished by your app. Only returned for receipts that contain auto-renewable subscriptions.
-In the JSON file, an array where each element contains the pending renewal information for each auto-renewable subscription identified by the product_id. Only returned for app receipts that contain auto-renewable subscriptions.
-A JSON representation of the receipt that was sent for verification.
-Either 0 if the receipt is valid, or a status code if there is an error. The status code reflects the status of the app receipt as a whole.
Generated using TypeDoc
Returns latest_receipt_info from UnifiedReceipt or VerifyReceiptResponseSuccess objects.
-Returns latest_receipt_info from UnifiedReceipt or VerifyReceiptResponseSuccess objects.
-Guard for verifyReceipt error results.
-Guard for verifyReceipt success results.
-Function to verifyReceipt receipts via Apple servers.
{VerifyReceiptFetchError}
Generated using TypeDoc
Error class for not OK responses.
-