Skip to main content
POST
/
subscriptions
/
{subscriptionId}
/
cancel
Cancel a subscription
curl --request POST \
  --url https://api.orafi.app/v1/subscriptions/{subscriptionId}/cancel \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Subscription canceled",
  "data": {
    "id": "sub_abc123",
    "customerId": "<string>",
    "planId": "<string>",
    "network": "SUI",
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "canceledAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
Cancels a subscription. When cancelled, the subscription will not renew and an appropriate webhook event is emitted.

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Path Parameters

​
subscriptionId
string
required

Response

Subscription canceled

​
success
boolean
Example:

true

​
message
string
Example:

"Subscription canceled"

​
data
object