Advanced Commerce API

Overview

Use this framework to offer an exceptionally large catalog of one-time purchases, subscriptions, and subscriptions with optional add-ons while using the App Store commerce system. Apps that use this API host and manage their own catalog of In-App Purchases, or SKUs. The App Store commerce system handles the end-to-end payment processing, global distribution, tax support, and customer service.

You can use the Advanced Commerce API and the StoreKit In-App Purchase API in the same app. Both APIs use the App Store commerce system, including the same signed JWS transactions and JWS renewal info. For products that you offer using the In-App Purchase API, you set up product identifiers in App Store Connect. For products that you offer using the Advanced Commerce API, you host and manage your own catalog of SKUs and add product details dynamically at runtime. For complete setup information, see Setting up your project for Advanced Commerce API.

Advanced Commerce API features are available through requests you make using StoreKit in your app and endpoint requests from your server. To authorize these requests, you generate JSON Web Tokens (JWTs). The App Store Server Library provides a client that makes it easier to create JWTs to authorize calls. For more information about the library, see Simplifying your implementation by using the App Store Server Library. For more information about authorizing calls, see Authorizing API requests from your server.

Your server must support the Transport Layer Security (TLS) protocol 1.2 or later to call the Advanced Commerce API.

Topics

Essentials

• Setting up your project for Advanced Commerce API
• Setting up a link to manage subscriptions
• Advanced Commerce API changelog

API authorization and rate limits

• Authorizing API requests from your server
• Identifying rate limits for Advanced Commerce APIs

Generic product IDs and SKUs

• Setting up generic product identifiers
• Creating SKUs for your In-App Purchases
• Creating SKUs for the Mini Apps Partner Program

Tax codes and pricing

• Specifying prices for Advanced Commerce SKUs
• Choosing tax codes for your SKUs
• Handling subscription price changes

In-app API requests

• Sending Advanced Commerce API requests from your app
• Generating JWS to sign App Store requests

One-time charge creation in the app

• OneTimeChargeCreateRequest
• OneTimeChargeItem

Subscription creation in the app

• SubscriptionCreateRequest
• SubscriptionCreateItem

Subscription modification in the app

• SubscriptionModifyInAppRequest
• SubscriptionModifyAddItem
• SubscriptionModifyChangeItem
• SubscriptionModifyRemoveItem
• SubscriptionModifyPeriodChange

Subscription reactivation in the app

• SubscriptionReactivateInAppRequest
• SubscriptionReactivateItem

Subscription price change from the server

• Change Subscription Price
• SubscriptionPriceChangeRequest
• SubscriptionPriceChangeResponse

Subscription cancellation from the server

• Cancel a Subscription
• SubscriptionCancelRequest
• SubscriptionCancelResponse

Subscription revocation from the server

• Revoke Subscription
• SubscriptionRevokeRequest
• SubscriptionRevokeResponse

Refund request from the server

• Request Transaction Refund
• RequestRefundRequest
• RequestRefundResponse
• RequestRefundItem

Subscription metadata changes from the server

• Change Subscription Metadata
• SubscriptionChangeMetadataRequest
• SubscriptionChangeMetadataResponse
• SubscriptionChangeMetadataDescriptors
• SubscriptionChangeMetadataItem

Migration from the server

• Migrate a Subscription to Advanced Commerce API
• SubscriptionMigrateRequest
• SubscriptionMigrateResponse
• SubscriptionMigrateItem
• SubscriptionMigrateRenewalItem
• SubscriptionMigrateDescriptors

Objects and types

• Data types

Signed transaction information

• JWSRenewalInfo
• JWSTransaction

Error handling

• Error messages and codes