|
5555 | 5555 | } |
5556 | 5556 | } |
5557 | 5557 | }, |
5558 | | - "revision": "20251028", |
| 5558 | + "revision": "20251119", |
5559 | 5559 | "rootUrl": "https://androidpublisher.googleapis.com/", |
5560 | 5560 | "schemas": { |
5561 | 5561 | "Abi": { |
|
6219 | 6219 | }, |
6220 | 6220 | "type": "object" |
6221 | 6221 | }, |
| 6222 | + "BaseDetails": { |
| 6223 | + "description": "Details of a base price pricing phase.", |
| 6224 | + "id": "BaseDetails", |
| 6225 | + "properties": {}, |
| 6226 | + "type": "object" |
| 6227 | + }, |
6222 | 6228 | "BasePlan": { |
6223 | 6229 | "description": "A single base plan for a subscription.", |
6224 | 6230 | "id": "BasePlan", |
|
7634 | 7640 | }, |
7635 | 7641 | "type": "object" |
7636 | 7642 | }, |
| 7643 | + "ExternalAccountIds": { |
| 7644 | + "description": "User account identifier in your app.", |
| 7645 | + "id": "ExternalAccountIds", |
| 7646 | + "properties": { |
| 7647 | + "obfuscatedAccountId": { |
| 7648 | + "description": "Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user account in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid to set this field for purchases made using the standard in-app billing flow.", |
| 7649 | + "type": "string" |
| 7650 | + }, |
| 7651 | + "obfuscatedProfileId": { |
| 7652 | + "description": "Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user profile in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid to set this field for purchases made using the standard in-app billing flow.", |
| 7653 | + "type": "string" |
| 7654 | + } |
| 7655 | + }, |
| 7656 | + "type": "object" |
| 7657 | + }, |
7637 | 7658 | "ExternalSubscription": { |
7638 | 7659 | "description": "Details of an external subscription.", |
7639 | 7660 | "id": "ExternalSubscription", |
|
7842 | 7863 | }, |
7843 | 7864 | "type": "object" |
7844 | 7865 | }, |
| 7866 | + "FreeTrialDetails": { |
| 7867 | + "description": "Details of a free trial pricing phase.", |
| 7868 | + "id": "FreeTrialDetails", |
| 7869 | + "properties": {}, |
| 7870 | + "type": "object" |
| 7871 | + }, |
7845 | 7872 | "FullRefund": { |
7846 | 7873 | "description": "A full refund of the remaining amount of a transaction.", |
7847 | 7874 | "id": "FullRefund", |
|
8576 | 8603 | }, |
8577 | 8604 | "type": "object" |
8578 | 8605 | }, |
| 8606 | + "IntroductoryPriceDetails": { |
| 8607 | + "description": "Details of an introductory price pricing phase.", |
| 8608 | + "id": "IntroductoryPriceDetails", |
| 8609 | + "properties": {}, |
| 8610 | + "type": "object" |
| 8611 | + }, |
8579 | 8612 | "IntroductoryPriceInfo": { |
8580 | 8613 | "description": "Contains the introductory price information for a subscription.", |
8581 | 8614 | "id": "IntroductoryPriceInfo", |
|
8601 | 8634 | }, |
8602 | 8635 | "type": "object" |
8603 | 8636 | }, |
| 8637 | + "ItemReplacement": { |
| 8638 | + "description": "Details about a subscription line item that is being replaced.", |
| 8639 | + "id": "ItemReplacement", |
| 8640 | + "properties": { |
| 8641 | + "basePlanId": { |
| 8642 | + "description": "The base plan ID of the subscription line item being replaced.", |
| 8643 | + "type": "string" |
| 8644 | + }, |
| 8645 | + "offerId": { |
| 8646 | + "description": "The offer ID of the subscription line item being replaced, if applicable.", |
| 8647 | + "type": "string" |
| 8648 | + }, |
| 8649 | + "productId": { |
| 8650 | + "description": "The product ID of the subscription line item being replaced.", |
| 8651 | + "type": "string" |
| 8652 | + }, |
| 8653 | + "replacementMode": { |
| 8654 | + "description": "The replacement mode applied during the purchase.", |
| 8655 | + "enum": [ |
| 8656 | + "REPLACEMENT_MODE_UNSPECIFIED", |
| 8657 | + "WITH_TIME_PRORATION", |
| 8658 | + "CHARGE_PRORATED_PRICE", |
| 8659 | + "WITHOUT_PRORATION", |
| 8660 | + "CHARGE_FULL_PRICE", |
| 8661 | + "DEFERRED", |
| 8662 | + "KEEP_EXISTING" |
| 8663 | + ], |
| 8664 | + "enumDescriptions": [ |
| 8665 | + "Unspecified replacement mode.", |
| 8666 | + "The new plan will be prorated and credited from the old plan.", |
| 8667 | + "The user will be charged a prorated price for the new plan.", |
| 8668 | + "The new plan will replace the old one without prorating the time.", |
| 8669 | + "The user will be charged the full price for the new plan.", |
| 8670 | + "The old plan will be cancelled and the new plan will be effective after the old one expires.", |
| 8671 | + "The plan will remain unchanged with this replacement." |
| 8672 | + ], |
| 8673 | + "type": "string" |
| 8674 | + } |
| 8675 | + }, |
| 8676 | + "type": "object" |
| 8677 | + }, |
8604 | 8678 | "LanguageTargeting": { |
8605 | 8679 | "description": "Targeting based on language.", |
8606 | 8680 | "id": "LanguageTargeting", |
|
9075 | 9149 | }, |
9076 | 9150 | "type": "object" |
9077 | 9151 | }, |
| 9152 | + "OfferPhaseDetails": { |
| 9153 | + "description": "Details of a pricing phase for the entitlement period funded by this order.", |
| 9154 | + "id": "OfferPhaseDetails", |
| 9155 | + "properties": { |
| 9156 | + "baseDetails": { |
| 9157 | + "$ref": "BaseDetails", |
| 9158 | + "description": "The order funds a base price period." |
| 9159 | + }, |
| 9160 | + "freeTrialDetails": { |
| 9161 | + "$ref": "FreeTrialDetails", |
| 9162 | + "description": "The order funds a free trial period." |
| 9163 | + }, |
| 9164 | + "introductoryPriceDetails": { |
| 9165 | + "$ref": "IntroductoryPriceDetails", |
| 9166 | + "description": "The order funds an introductory pricing period." |
| 9167 | + }, |
| 9168 | + "prorationPeriodDetails": { |
| 9169 | + "$ref": "ProrationPeriodDetails", |
| 9170 | + "description": "The order funds a proration period." |
| 9171 | + } |
| 9172 | + }, |
| 9173 | + "type": "object" |
| 9174 | + }, |
9078 | 9175 | "OfferTag": { |
9079 | 9176 | "description": "Represents a custom tag specified for a product offer.", |
9080 | 9177 | "id": "OfferTag", |
|
9740 | 9837 | }, |
9741 | 9838 | "type": "object" |
9742 | 9839 | }, |
| 9840 | + "OutOfAppPurchaseContext": { |
| 9841 | + "description": "Information specific to an out of app purchase.", |
| 9842 | + "id": "OutOfAppPurchaseContext", |
| 9843 | + "properties": { |
| 9844 | + "expiredExternalAccountIdentifiers": { |
| 9845 | + "$ref": "ExternalAccountIdentifiers", |
| 9846 | + "description": "User account identifier from the last expired subscription for this SKU." |
| 9847 | + }, |
| 9848 | + "expiredPurchaseToken": { |
| 9849 | + "description": "The purchase token of the last expired subscription. This purchase token must only be used to help identify the user if the link between the purchaseToken and user is stored in your database. This cannot be used to call the Google Developer API if it has been more than 60 days since expiry.", |
| 9850 | + "type": "string" |
| 9851 | + } |
| 9852 | + }, |
| 9853 | + "type": "object" |
| 9854 | + }, |
9743 | 9855 | "PageInfo": { |
9744 | 9856 | "description": "Information about the current page. List operations that supports paging return only one \"page\" of results. This protocol buffer message describes the page that has been returned.", |
9745 | 9857 | "id": "PageInfo", |
|
10197 | 10309 | }, |
10198 | 10310 | "type": "object" |
10199 | 10311 | }, |
| 10312 | + "ProrationPeriodDetails": { |
| 10313 | + "description": "Details of a proration period. A proration period can be a period calculated during a plan change to cover existing entitlements (For more information, see [Allow users to upgrade, downgrade, or change their subscription](https://developer.android.com/google/play/billing/subscriptions#allow-users-change), or a prorated period to align add-on renewal dates with the base (For more information, see [Rules applicable for items in the purchase](https://developer.android.com/google/play/billing/subscription-with-addons#rules-base-addons)).", |
| 10314 | + "id": "ProrationPeriodDetails", |
| 10315 | + "properties": { |
| 10316 | + "linkedOrderId": { |
| 10317 | + "description": "The last order id of the original subscription purchase prior to the plan change. This is only populated if this proration period is from an ugrade/downgrade from a previous subscription and carries the remaining offer phase from the linked order of the previous subscription.", |
| 10318 | + "type": "string" |
| 10319 | + }, |
| 10320 | + "originalOfferPhase": { |
| 10321 | + "description": "Represent the original offer phase from the purchased the line item if the proration period contains any of them. For example, a proration period from CHARGE_FULL_PRICE plan change may merge the 1st offer phase of the subscription offer of the new product user purchased. In this case, the original offer phase will be set here.", |
| 10322 | + "enum": [ |
| 10323 | + "OFFER_PHASE_UNSPECIFIED", |
| 10324 | + "BASE", |
| 10325 | + "INTRODUCTORY", |
| 10326 | + "FREE_TRIAL" |
| 10327 | + ], |
| 10328 | + "enumDescriptions": [ |
| 10329 | + "Offer phase unspecified. This value is not used.", |
| 10330 | + "The order funds a base price period.", |
| 10331 | + "The order funds an introductory pricing period.", |
| 10332 | + "The order funds a free trial period." |
| 10333 | + ], |
| 10334 | + "type": "string" |
| 10335 | + } |
| 10336 | + }, |
| 10337 | + "type": "object" |
| 10338 | + }, |
10200 | 10339 | "PurchaseOptionTaxAndComplianceSettings": { |
10201 | 10340 | "description": "Details about taxation, Google Play policy and legal compliance for one-time product purchase options.", |
10202 | 10341 | "id": "PurchaseOptionTaxAndComplianceSettings", |
|
11088 | 11227 | "type": "string" |
11089 | 11228 | }, |
11090 | 11229 | "offerPhase": { |
11091 | | - "description": "The pricing phase for the billing period funded by this order.", |
| 11230 | + "description": "The pricing phase for the billing period funded by this order. Deprecated. Use offer_phase_details instead.", |
11092 | 11231 | "enum": [ |
11093 | 11232 | "OFFER_PHASE_UNSPECIFIED", |
11094 | 11233 | "BASE", |
|
11103 | 11242 | ], |
11104 | 11243 | "type": "string" |
11105 | 11244 | }, |
| 11245 | + "offerPhaseDetails": { |
| 11246 | + "$ref": "OfferPhaseDetails", |
| 11247 | + "description": "The pricing phase details for the entitlement period funded by this order." |
| 11248 | + }, |
11106 | 11249 | "servicePeriodEndTime": { |
11107 | 11250 | "description": "The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get.", |
11108 | 11251 | "format": "google-datetime", |
|
11473 | 11616 | "format": "google-datetime", |
11474 | 11617 | "type": "string" |
11475 | 11618 | }, |
| 11619 | + "itemReplacement": { |
| 11620 | + "$ref": "ItemReplacement", |
| 11621 | + "description": "Details of the item being replaced. This field is only populated if this item replaced another item in a previous subscription and is only available for 60 days after the purchase time." |
| 11622 | + }, |
11476 | 11623 | "latestSuccessfulOrderId": { |
11477 | 11624 | "description": "The order id of the latest successful order associated with this item. Not present if the item is not owned by the user yet (e.g. the item being deferred replaced to).", |
11478 | 11625 | "type": "string" |
|
11542 | 11689 | "description": "The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription.", |
11543 | 11690 | "type": "string" |
11544 | 11691 | }, |
| 11692 | + "outOfAppPurchaseContext": { |
| 11693 | + "$ref": "OutOfAppPurchaseContext", |
| 11694 | + "description": "Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription." |
| 11695 | + }, |
11545 | 11696 | "pausedStateContext": { |
11546 | 11697 | "$ref": "PausedStateContext", |
11547 | 11698 | "description": "Additional context around paused subscriptions. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_PAUSED." |
|
11599 | 11750 | "developerPayload": { |
11600 | 11751 | "description": "Payload to attach to the purchase.", |
11601 | 11752 | "type": "string" |
| 11753 | + }, |
| 11754 | + "externalAccountIds": { |
| 11755 | + "$ref": "ExternalAccountIds", |
| 11756 | + "description": "Optional. User account identifier in your app." |
11602 | 11757 | } |
11603 | 11758 | }, |
11604 | 11759 | "type": "object" |
|
0 commit comments