POST
/
groups
/
{id}
/
expire
curl --request POST \
  --url https://api.kohortpay.com/groups/{id}/expire \
  --header 'Authorization: Bearer <token>'
{
  "id": "ord_1234567890",
  "shareId": "KHT-XXXXXXXX",
  "livemode": true,
  "organizationId": "org_1234567890",
  "customerId": "cus_1234567890",
  "creatorEmail": "[email protected]",
  "status": "COMPLETED",
  "metadata": {
    "basket_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
  },
  "expiresAt": "2021-07-22T00:00:00.000Z",
  "midExpireAt": "2021-07-22T00:00:00.000Z",
  "jMinus2ExpireAt": "2021-07-22T00:00:00.000Z",
  "jPlus3StartAt": "2021-07-22T00:00:00.000Z",
  "reminderEmailSent": "NOT_SENT",
  "createdAt": "2021-07-22T00:00:00.000Z",
  "createdBy": "usr_1234567890",
  "updatedAt": "2021-07-22T00:00:00.000Z",
  "updatedBy": "usr_1234567890",
  "canceledAt": "2021-07-22T00:00:00.000Z",
  "completedAt": "2021-07-22T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique group ID

Response

200 - application/json

Group successfully canceled.

The response is of type object.