Agencies

Withdraw an open payment link

Marks an open payment link of your agency as expired, also after your relation with the client ended. The checkout at your payment provider expires on its own; if it is still paid, the money is on your own account.

delete/clients/{id}/payment-links/{linkId}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/{id}/payment-links/{linkId}
  • 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.

linkIdstring uuid required

The id of the payment link.

Response

The withdrawn payment link.

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.