| Name | Type | Description | Notes |
|---|---|---|---|
| id | AllOfSubscriptionCancellationId | Cancellation identifier. | [optional] |
| subscription_id | AllOfSubscriptionCancellationSubscriptionId | Identifier of the canceled subscription order. | |
| prorated_invoice_id | AllOfSubscriptionCancellationProratedInvoiceId | Identifier of the invoice on which the cancellation proration is calculated. | [optional] |
| applied_invoice_id | AllOfSubscriptionCancellationAppliedInvoiceId | The identifier of the invoice where the cancellation fees or credits are applied. | [optional] |
| canceled_by | String | Who did the cancellation. | [optional] [default to 'customer'] |
| reason | String | Cancellation reason. | [optional] [default to 'other'] |
| description | String | Cancel reason description in free form. | [optional] |
| prorated | BOOLEAN | Defines if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription's next renewal time. | [optional] [default to false] |
| status | String | "draft" defines that the cancellation isn't applied on an invoice and subscription but can be inspected to see the charge. "confirmed" will set a subscription to be canceled when the `churnTime` is reached. "completed" is a read-only status which is set by the system when the churnTime is reached. The cancellation may not be changed or deleted when the status is "completed". | [optional] [default to 'confirmed'] |
| canceled_time | DateTime | The cancellation time (when the status is confirmed which is by default unless specified "draft"). | [optional] |
| created_time | AllOfSubscriptionCancellationCreatedTime | The time of resource creation (when it is posted). | [optional] |
| churn_time | DateTime | The time when the subscription will be deactivated. | |
| line_items | AllOfSubscriptionCancellationLineItems | Items to be added to the new invoice. Proration item is generated and added automatically. | [optional] |
| line_item_subtotal | BigDecimal | Subtotal of the line items which will be added after the subscription's cancellation. | [optional] |
| _links | Array<SelfLink> | The links related to resource. | [optional] |