SetMockAppSubscription
Sets a mock app subscription for the current account, enabling testing scenarios.
Input
Name | Type | Required | Description |
AppId | String | True | The unique identifier of the application for which the subscription is being simulated, used to associate the mock subscription with the correct app in the system. |
PartialSigningSecret | String | True | The last 10 characters of the application's signing secret, used for verifying and authenticating the app during the subscription mock process. |
PlanId | String | False | The unique identifier of the plan to be simulated in the mock subscription, ensuring the correct plan is applied to the subscription. |
IsTrial | Boolean | False | A boolean flag indicating whether the subscription being mocked is a trial subscription, which may affect the pricing and renewal terms. |
RenewalDate | Datetime | False | The date when the subscription will be renewed. This field is essential for determining the timing of the next billing cycle or trial expiration. |
BillingPeriod | String | False | The frequency of billing for the subscription, either monthly or yearly, which dictates the payment schedule and the subscription's renewal cycle. |
PricingVersion | Int | False | The version of the pricing structure being applied to the mock subscription, allowing flexibility in testing different pricing models. |
Result Set Columns
Name | Type | Description |
Success | Boolean | A flag indicating whether the subscription mock operation was completed successfully. A value of 'true' means the mock was successfully applied, and 'false' indicates an error or failure. |
Details | String | Additional context or messages regarding the outcome of the mock subscription operation, useful for debugging or understanding why an operation might have failed. |
PlanId | String | The plan ID that was assigned to the mocked subscription, reflecting the plan used in the simulated subscription setup. |