POST api/subscriptions/{subscriptionId}/autotopup
Tops up the specified subscription with the paid amount, and enables auto-topup for the future using the same payment information.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
subscriptionId |
The subscription for which to enable automatic topup. |
integer |
Required |
Body Parameters
An object containing the necessary information to complete the operation.
EnableAutoTopupRequestName | Description | Type | Additional information |
---|---|---|---|
PaymentId | integer |
None. |
|
Amount | decimal number |
None. |
|
Threshold | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{ "PaymentId": 1, "Amount": 2.0, "Threshold": 3.0 }
text/html
Sample:
{"PaymentId":1,"Amount":2.0,"Threshold":3.0}
application/xml, text/xml
Sample:
<SubscriptionsController.EnableAutoTopupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LimitlessMobile.WebAPI.Controllers"> <Amount>2</Amount> <PaymentId>1</PaymentId> <Threshold>3</Threshold> </SubscriptionsController.EnableAutoTopupRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The order for the ad-hoc top-up which is made before enabling auto-topup.
OrderName | Description | Type | Additional information |
---|---|---|---|
CategoryId | integer |
None. |
|
CreatedDate | date |
None. |
|
Date | date |
None. |
|
Id | integer |
None. |
|
OrderTypeId | integer |
None. |
|
PhoneNumber | string |
None. |
|
SalesCode | string |
None. |
|
StatusId | integer |
None. |
|
SubscriptionId | integer |
None. |
|
WholeSalesPartnerId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "CategoryId": 1, "CreatedDate": "2025-04-28T01:55:32.9634336+02:00", "Date": "2025-04-28T01:55:32.9634336+02:00", "Id": 4, "OrderTypeId": 5, "PhoneNumber": "sample string 6", "SalesCode": "sample string 7", "StatusId": 8, "SubscriptionId": 1, "WholeSalesPartnerId": 9 }
text/html
Sample:
{"CategoryId":1,"CreatedDate":"2025-04-28T01:55:32.9634336+02:00","Date":"2025-04-28T01:55:32.9634336+02:00","Id":4,"OrderTypeId":5,"PhoneNumber":"sample string 6","SalesCode":"sample string 7","StatusId":8,"SubscriptionId":1,"WholeSalesPartnerId":9}
application/xml, text/xml
Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CategoryId>1</CategoryId> <CreatedDate>2025-04-28T01:55:32.9634336+02:00</CreatedDate> <Date>2025-04-28T01:55:32.9634336+02:00</Date> <Id>4</Id> <OrderTypeId>5</OrderTypeId> <PhoneNumber>sample string 6</PhoneNumber> <SalesCode>sample string 7</SalesCode> <StatusId>8</StatusId> <SubscriptionId>1</SubscriptionId> <WholeSalesPartnerId>9</WholeSalesPartnerId> </Order>