Web サービスエンドポイント

サブスクリプションのメタデータの変更

サブスクリプションの請求やそのサービスに影響を与えずに、サブスクリプションに関連した SKU、表示名、説明を更新します。

Advanced Commerce API 1.0+

URL

POST https://api.storekit.itunes.apple.com/advancedCommerce/v1/subscription/changeMetadata/
{transactionId}

サンドボックス URL

POST https://api.storekit-sandbox.itunes.apple.com/advancedCommerce/v1/subscription/changeMetadata/{transactionId}

パスパラメータ

transactionId
string

(必須)自動更新サブスクリプションのメタデータの変更を取得するための取引 ID。サブスクリプションの元の取引 ID、またはサブスクリプションに関連する取引のそれ以降の取引 ID を使用します。

HTTP 本体

SubscriptionChange
MetadataRequest

メタデータの変更を含む要求本文。
Content-Type: application/json

応答コード

200 SubscriptionChange MetadataResponse	OK 要求は成功しました。 Content-Type: application/json
400 (RepeatedRequest ReferenceIdError \| Null RequestInfoError \| Null EffectiveError \| InvalidAppAccountToken Error \| NullRequest ReferenceIDError \| InvalidRequestReference IDError \| Invalid ConsistencyTokenError \| InvalidStorefrontError \| SKULengthExceeded Error \| Description LengthExceededError \| DisplayNameLength ExceededError \| Invalid ProductChangesError \| InvalidDisplayNameError \| InvalidDescription Error \| InvalidProduct Error \| InvalidSKUError \| InvalidTaxProductCode Error \| Mismatched StorefrontError \| MismatchedStorefront Error \| OperationNot AllowedError \| MalformedPayloadError \| AtLeastOneItemError \| AtLeastOneOfDisplayName OrDescriptionError)	不正な要求です Content-Type: application/json
401	許可されていません認証ヘッダー内の JSON Web Token (JWT) が無効です。詳細については、あなたのサーバーからの API 要求の承認をご覧ください。
403 (SubscriptionDoesNot ExistError \| SubscriptionNotEligible Error \| ProductNotOwned Error \| InactiveACASub Error \| ProductNot EligibleError)	禁止されている Content-Type: application/json
404 TransactionIdNotFound Error \| ProductNotFound Error)	見つからない Content-Type: application/json
429 RateLimitExceededError	要求がレート制限を超えました。詳細については、Advanced Commerce API のレート制限の特定をご覧ください。 Content-Type: application/json
500 (GeneralInternalError \| GeneralInternal RetryableError)	内部サーバーエラーサーバーエラーです。後で再度試して下さい。 Content-Type: application/json

以下で言及

Advanced Commerce API の変更履歴

Advanced Commerce API のレート制限の特定

あなたのサーバーからの API 要求の承認

議論

このエンドポイントを使用して、自動更新サブスクリプションの表示名と説明を更新します。このエンドポイントを呼び出しても、価格、請求詳細、サービス内容は変更されません。例えば、ブランド変更に伴いサブスクリプションの表示名が変更された場合は、Change Subscription Metadata (サブスクリプションのメタデータの変更) を呼び出すことができます。

顧客がサブスクリプションを変更して異なるサービスを受ける場合 (アップグレード、ダウングレード、クロスグレードなど) は、このエンドポイントを呼び出さないでください。このような変更には、SubscriptionModifyInAppRequest を使用してください。