SMsmokeball
Subscriptions

Cancel usage charge

Cancels (refunds) a usage charge. The cancellation is processed asynchronously.

Important considerations:

  • Only charges in the 'Succeeded' status can be canceled
  • Charges can only be canceled within 24 hours of the charge being created
  • The caller must be authorized for usage billing on the charged product
post/subscriptions/{subscriptionId}/charges/{id}/cancel

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/{subscriptionId}/charges/{id}/cancel
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

subscriptionIdstring required

The unique identifier of the usage subscription

idstring uuid required

The unique identifier of the usage charge to cancel

Request body

reasonstring nullable

Response

When request is accepted. Returns a 'Link' object to the charge.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.