Skip to main content
POST
json

Body

application/json
PhoneNumbers
object[]
required

Array of phone numbers to update renewal settings for

AutoRenew
boolean
required

Whether data usage automatically resets on the configured RenewalDay each period

Example:

true

PeriodType
enum<string>
required

Renewal period type. M for monthly, W for weekly

Available options:
M,
W
Example:

"M"

RenewalDay
integer
required

Day on which usage resets. 1-31 for monthly periods, 1-7 for weekly periods

Example:

1

ResetUsage
boolean

Set to true to zero out current usage immediately without waiting for the next renewal cycle

Example:

false

PeriodValue
integer

Number of periods between renewals. Typically 1

Example:

1

Response

Renewal settings updated successfully

The response is of type object.