Schedule the update of an existing line item

PUT /accounts/{account_id}/line_items/{line_item_id}/schedule

Path parameters

Body

Schedule the update of a specific line item.

  • line_item_status string

    The new status which you would like to set for the line item

    Values are VALID, INVALID, OFFSET, PENDING, AUTHORIZED, DECLINED, VOID, or POSTED. Default value is VALID.

  • original_amount_cents integer

    The updated amount (in cents).

  • effective_at string(date-time)

    The Date-Time that the update is made applicable to the line item.

Responses

  • • 202

    Event scheduled.

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 404

    Account or line item could not be found.

  • • 422

    Invalid input.

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

PUT /accounts/{account_id}/line_items/{line_item_id}/schedule 
curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/line_items/can_52322/schedule \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"line_item_status":"VALID","original_amount_cents":200,"effective_at":"2020-07-20T09:11:28+00:00"}'
Request example 
{
  "line_item_status": "VALID",
  "original_amount_cents": 200,
  "effective_at": "2020-07-20T09:11:28+00:00"
}