v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

ProductAllowances

View productallowance

Find a single productallowance by ID.

get/v1/ProductAllowances/{id}

idinteger required

ID of the productallowance to view.

okboolean

product_allowance_idinteger

Primary identifier for this product allowance.

product_idinteger required

Foreign identifier indicating which product this allowance belongs to.

allowance_typestring required

Type of allowance. Valid values: Voice, SMS, MMS, Data.

unlimitedboolean

Indicates whether this allowance has no quantity cap.

quantityinteger

Number of units included in this allowance. Must be greater than 0 when unlimited is false.

expiration_daysinteger

Number of days after which this allowance expires. Use 0 for no expiration.

share_method'NONE' | 'ALL' | 'SAME_PACKAGE' | 'SAME_LINE_TYPE' | 'WITH_PRODUCT'

Determines how this allowance is shared. Valid values: NONE, ALL, SAME_PACKAGE, SAME_LINE_TYPE, WITH_PRODUCT.

share_with_hierarchyboolean

Indicates whether this allowance is shared with parent, child, and sibling lines in the hierarchy.

roaming_flagboolean

Indicates whether this allowance applies when roaming. Null means not applicable.

created_datestring date-time

Date and time this allowance was created.

created_byinteger

Foreign identifier indicating which user created this allowance.