ProductTimePasses
Update ProductTimePass
Update an existing ProductTimePass record.
PUT
Update ProductTimePass
Updates an existing ProductTimePass record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ProductTimePass-Edit role.Enums
eRecurrentChargePattern
eRecurrentChargePattern
| Value | Name |
|---|---|
| 1 | PricePlan |
| 2 | Day |
| 3 | Week |
| 4 | Month |
| 5 | Year |
| 6 | LastDayOfMonth |
Request Body
Required Fields
The Id of the ProductTimePass record to update.
ID of the product linked to this record.
ID of the time pass linked to this record.
Passes included.
Optional Fields
The expire time in months value for this product time pass.
The expire time in weeks value for this product time pass.
Expiration type. See
eRecurrentChargePattern? enum above.Expires in.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the producttimepass was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update ProductTimePass