SetMockAppSubscription
Sets a mock application subscription for the current account, simulating app usage.
Input
Name | Type | Required | Description |
AppId | String | True | The unique identifier for the application that is being used to simulate a subscription. This helps to associate the operation with the correct app in the system. |
PartialSigningSecret | String | True | A masked version of the app's signing secret, providing the last 10 characters. This is used to authenticate the app during the mock subscription process. |
PlanId | String | False | The identifier for the specific subscription plan that is being mocked, enabling the system to associate the subscription with the correct pricing structure. |
IsTrial | Boolean | False | A boolean flag that indicates whether the mocked subscription is a trial version. It helps to apply the appropriate subscription rules and benefits. |
RenewalDate | Datetime | False | The date when the subscription is set to renew. This is used to manage subscription lifecycles and calculate any recurring billing events. |
BillingPeriod | String | False | The frequency of the billing cycle, either monthly or yearly. This affects the subscription's renewal schedule and the pricing structure. |
PricingVersion | Int | False | The version of the pricing plan that is being applied. This helps ensure the mock subscription uses the correct pricing model according to the version specified. |
Result Set Columns
Name | Type | Description |
Success | Boolean | A status flag indicating the outcome of the operation. A value of true means the subscription mock was successfully created or updated, while false indicates an error. |
Details | String | A message containing additional information about the operation's execution, providing insights into any issues or further details on success or failure. |
PlanId | String | The identifier for the mocked subscription plan returned after the operation. It confirms the plan that was successfully applied or mocked in the process. |