Skip to main content

schedule entitlement cancellation

POST 
/org/:orgId/entitlement/:entitlementId/scheduleCancellation

Schedule the cancellation of the given Entitlement.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    entitlementId stringrequired

    Entitlement ID

Body

required

RequestBody

    cancelDate string

    The cancellation date of the entitlement. It is required when the type is SpecificDate.

    creationDate string

    When this cancellation schedule is created.

    note string

    Possible values: <= 500 characters

    The cancellation note. Max 500 characters.

    type CancellationScheduleType (string)

    Possible values: [EndOfTerm, Immediate, SpecificDate]

Responses​

OK

Schema

    string

Loading...