Basic Information

appmixer.stripe.core.CancelSubscription

1.0.0

Public

Cancels a subscription immediately. The customer is not charged again for it. Optionally creates a final invoice and prorates the unused time.

Input Ports

in

FieldTypeDescription
Subscription ID text The ID of the subscription to cancel, e.g. sub_1MlPf9LkdIwHu7ixB6VIYRyX.
Invoice Now toggle Generate a final invoice for any un-invoiced metered usage and pending proration invoice items.
Prorate toggle Generate a proration invoice item that credits the unused time until the end of the period.
Cancellation Comment text A comment about why the subscription was canceled, stored in the subscription's cancellation details.

Output Ports

out

FieldTypeDescription
Subscription ID string -
Object string -
Status string -
Customer ID string -
Canceled At (Unix Timestamp) integer,null -
Ended At (Unix Timestamp) integer,null -
Latest Invoice ID string,null -
Cancellation Details object -
Live Mode boolean -
Metadata object -

Full Metadata