Cancel an Add-on

post

https://api.brilo.tech/api/subscriptions/{subscription_id}/addons/{addon_id}/cancel/

Removes or cancels an active add-on from a specific subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

addon_id

string

required

The ID of the addon within the subscription update.

subscription_id

string

required

The ID of the subscription to update.

Body Params

flat_fee_behavior

string | null

enum

When canceling a subscription, the behavior used to calculate the flat fee. If null or not provided, the charge's default behavior will be used according to the subscription's start and end dates. If charge_full, the full flat fee will be charged, regardless of the duration of the subscription. If refund, the flat fee will not be charged. If charge_prorated, the prorated flat fee will be charged.

refund - Refund
charge_prorated - Prorate
charge_full - Charge Full

Allowed:

usage_behavior

string

enum

Defaults to bill_full

If bill_full, current usage will be billed on the invoice. If bill_none, current unbilled usage will be dropped from the invoice. Defaults to bill_full.

bill_full - Bill Full
bill_none - Bill None

Allowed:

invoicing_behavior

string

enum

Defaults to invoice_now

Whether to invoice now or invoice at the end of the billing period. Defaults to invoice now.

add_to_next_invoice - Add to Next Invoice
invoice_now - Invoice Now

Allowed:

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200