API Reference

Cancel a subscription

post
https://test-api.acquired.com/v1/subscriptions//cancel

Cancel a subscription immediately, or at the end of the current period with at_period_end=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier for the subscription.

Query Params
boolean
Defaults to false

When false (default), the subscription is cancelled immediately and outstanding draft bills are voided. When true, the subscription remains in its current status and is cancelled automatically when the next bill becomes due — that bill is voided and no payment is taken for it (the cancel_at_period_end field on the subscription is set to true).

string

Comma-separated list of fields to expand in the response. Fields marked as Expandable in the response schema can be expanded. Supported fields: product, price, discount.

Responses

Updated 6 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 days ago