mayarin
API Reference
POST
/v1/subscriptions/{id}/cancel

Terminal. A cancelled subscription cannot be resumed.

Authorization

secretKey
AuthorizationBearer <token>

Server-side sk_ key. Grants a subset of the merchant's permissions.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/subscriptions/string/cancel"
{  "id": "string",  "subscriber": {    "customerId": "string",    "name": "string",    "email": "string"  },  "description": "string",  "amount": {    "amount": "string",    "asset": "string",    "formatted": "string",    "display": "string"  },  "interval": "week",  "state": "active",  "billedCycles": 0,  "daysUntilDue": 0,  "anchorAt": "string",  "nextBillingAt": "string",  "createdAt": "string",  "cancelledAt": "string"}

Resume a subscription

Billing restarts from the next period; every period missed while paused is skipped, not back-billed.

Receive a provider webhook

Provider callback surface. Integrators normally configure outbound merchant webhooks in the dashboard instead of calling this operation. The raw body is passed to the adapter so signatures verify over exactly the signed bytes.