Cancel a schedule
POST {{baseUrl}}/v1/subscription_schedules/:schedule/cancel
Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started
or active
.
Request Body
[{"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_now", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"prorate", "value"=>"<boolean>", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |