Agencies

Cancel a client subscription

Stops a subscription at your payment provider right away: no more charges. What was paid stays paid; nothing is refunded.

delete/clients/{id}/subscriptions/{subscriptionId}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/{id}/subscriptions/{subscriptionId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: clients:write)

Path parameters

idstring uuid required

The id of the client project.

subscriptionIdstring uuid required

The id of the subscription.

Response

The canceled subscription.

object'client_payment_link' | 'client_subscription' required
idstring uuid required
client_project_idstring uuid required
status'open' | 'paid' | 'failed' | 'expired' | 'active' | 'canceled' required
amount_centsinteger required
fee_centsinteger required
currencystring required
descriptionstring required
interval'month' | 'year' | 'null' nullable
paid_untilstring nullable
canceled_atstring nullable
testboolean required
checkout_urlstring nullable required
paid_atstring nullable required
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.