Skip to content

Instantly share code, notes, and snippets.

@gera-cameron
Last active January 22, 2019 18:43
Show Gist options
  • Save gera-cameron/6be1fa4e7f934e605597a587e0b051a3 to your computer and use it in GitHub Desktop.
Save gera-cameron/6be1fa4e7f934e605597a587e0b051a3 to your computer and use it in GitHub Desktop.

Amendment Endpoint

Route: /api/supervisor/v1/amendment

Authorization: Required (Same way as Provision Endpoint)

Content-Type: application/json

Body Params:

  • enterpriseGrantId is the enterprise grant that the amendment is for.
  • seatChange is the number of seats we want to add to the grant. If we don't want to do this, please send 0.
  • terminationDate is the date we want to set to terminate the grant. If we don't want to do this, please send the original end date.
  • expiryReason is the reason in which we want to expire. If we don't want an expire reason, please send null.

Sample expiration:

{
  "enterpriseGrantId": "ABCD-EF01-2345", 
  "seatChange": 0, 
  "terminationDate": "2018-07-24", 
  "expiryReason": "non-payment"
}

Sample restoration/extention:

{
  "enterpriseGrantId": "ABCD-EF01-2345", 
  "seatChange": 0, 
  "terminationDate": "2019-07-24", 
  "expiryReason": null
}

Sample add seats:

{
  "enterpriseGrantId": "ABCD-EF01-2345", 
  "seatChange": 5, 
  "terminationDate": "2019-07-24", 
  "expiryReason": null
}

Sample remove seats:

{
  "enterpriseGrantId": "ABCD-EF01-2345", 
  "seatChange": -5, 
  "terminationDate": "2019-07-24", 
  "expiryReason": null
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment