Update subscription status
Body Parameters
The access key provided by TG.
The secret key provided by TG.
This field is deprecated and will be removed in future versions.
User's phone number. Optional if ExternalUserId or TgUserId is provided. When all three identifiers (TgUserId, ExternalUserId, and MSISDN) are provided, the system will prioritize them in the following order: TgUserId, ExternalUserId, and MSISDN. If no user is found with the provided phone number, a new user will be automatically created.
Unique Id for this transaction. Used for logging and troubleshooting purposes.
The application ID used to map the configuration. TG to provide.
The subscription plan ID.
The transaction type.
SubUnsubThis field is deprecated and will be removed in future versions.
This field is deprecated and will be removed in future versions.
The raw response body from the external billing system.
The trial expiry date. This is a legacy field and may be deprecated in future versions.
The user circle / region information.
This field is deprecated and will be removed in future versions.
The subscription start date. Required only when the transaction type is Sub. Accepted formats are either full ISO 8601 date-time YYYY-MM-DDTHH:MM:SSZ or date-only YYYY-MM-DD.
The subscription end date. Required only when the transaction type is Sub. Accepted formats are either full ISO 8601 date-time YYYY-MM-DDTHH:MM:SSZ or date-only YYYY-MM-DD.
The unique identifier for a subscription. If provided, the system will attempt to update the existing subscription with this ID. If not provided, any existing subscriptions for the user will be removed, and a new subscription will be created. It's recommended to provide the SubId when renewing an existing subscription to ensure continuity and prevent unintended replacement.
The external system identifier for the user. Optional if MSISDN or TgUserId is provided. When all three identifiers (TgUserId, ExternalUserId, and MSISDN) are provided, the system will prioritize them in the following order: TgUserId, ExternalUserId, and MSISDN. If no user is found with the provided external ID, a new user will be automatically created.
The Tuned Global user Id. Optional if MSISDN or ExternalUserId is provided. When all three identifiers (TgUserId, ExternalUserId, and MSISDN) are provided, the system will prioritize them in the following order: TgUserId, ExternalUserId, and MSISDN. If no user is found with this ID, a new user will be automatically created using the MSISDN provided.
This field indicates whether the user has had a trial period. Defaults to false.
The email of the user. Optional if at least one of the identifiers (MSISDN, ExternalUserId, or TgUserId) is provided
Response
Subscription status was processed successfully.
The request failed to be processed. The response body contains the error message.
Response