Skip to main content
DELETE
/
subscriptions
/
addon
Remove addon from subscription
curl --request DELETE \
  --url https://us.api.flexprice.io/v1/subscriptions/addon \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "addon_association_id": "<string>",
  "effective_date": "2023-11-07T05:31:56Z",
  "proration_behavior": "create_prorations",
  "reason": "<string>"
}
'
{
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Remove Addon Request

​
addon_association_id
string
required
​
effective_date
string<date-time>

EffectiveDate is the date the cancellation takes effect. When nil the addon is cancelled at the end of the current period. When provided it must fall within [CurrentPeriodStart, CurrentPeriodEnd]; mid-period values combined with create_prorations will issue a wallet credit for unused time.

​
proration_behavior
enum<string>
Available options:
create_prorations,
none
​
reason
string

Response

OK

​
message
string